hep.aida
Interface ICloud

All Superinterfaces:

IBaseHistogram

All Known Subinterfaces:

ICloud1D, ICloud2D, ICloud3D

public interface ICloud

extends IBaseHistogram

User level interface to a Cloud. A Cloud is an unbinned collection of points. It can be used to represent scatter plots or dynamically rebinnable histograms. If they number of entries in the cloud exceeds some threshold they may be automatically converted to a binned histogram.

Author:

The AIDA team (http://aida.freehep.org/)

Method Summary

void	convertToHistogram() Convert the ICloud to an IHistogram using the default number of bins.
boolean	isConverted() Check if the ICloud has been converted to an IHistogram.
int	maxEntries() Get the number of entries after which the cloud will be converted to an IHistogram.
void	scale(double scaleFactor) Scale the weights by a given factor.
double	sumOfWeights() Get the sum of weights of all the entries.

Methods inherited from interface hep.aida.IBaseHistogram

annotation, dimension, entries, nanEntries, reset, setTitle, title

Method Detail

sumOfWeights

public double sumOfWeights()

Get the sum of weights of all the entries.

Returns:

The sum of the weights of all the entries.

convertToHistogram

public void convertToHistogram()
                        throws AlreadyConvertedException

Convert the ICloud to an IHistogram using the default number of bins.

Throws:

AlreadyConvertedException - If the ICloud has already been converted.

isConverted

public boolean isConverted()

Check if the ICloud has been converted to an IHistogram.

Returns:

true if it has been converted.

maxEntries

public int maxEntries()

Get the number of entries after which the cloud will be converted to an IHistogram.

Returns:

The number of entries.

scale

public void scale(double scaleFactor)
           throws IllegalArgumentException

Scale the weights by a given factor.

Parameters:

scaleFactor - The scale factor.

Throws:

IllegalArgumentException - If a non-positive scale factor is provided.