hep.aida.ref.histogram
Class Cloud

java.lang.Object
  hep.aida.ref.event.AIDAObservable
      hep.aida.ref.ManagedObject
          hep.aida.ref.histogram.AbstractBaseHistogram
              hep.aida.ref.histogram.Cloud

All Implemented Interfaces:

hep.aida.dev.IDevManagedObject, IBaseHistogram, ICloud, IManagedObject, Connectable, IsObservable, Serializable

Direct Known Subclasses:

Cloud1D, Cloud2D, Cloud3D

public abstract class Cloud
extends AbstractBaseHistogram
implements ICloud, Serializable, IsObservable

See Also:

Serialized Form

Field Summary

static int

CLOUD_ARRAY_ENTRIES

Method Summary

abstract void	convertToHistogram() Convert the ICloud to an IHistogram using the default number of bins.
String	getOptions() Get the options with which the Cloud was created.
void	initCloud(int maxEntries, String options)
abstract boolean	isConverted() Check if the ICloud has been converted to an IHistogram.
int	maxEntries() Get the maximum number of entries after which the Cloud will convert to an Histogram.
int	nanEntries() Number of entries whose coordinate or weight is NaN.
void	reset() Reset the histogram; as if just created.
abstract void	scale(double scaleFactor) Scale the weights by a given factor.
abstract double	sumOfWeights() Get the sum of weights of of all the entries

Methods inherited from class hep.aida.ref.histogram.AbstractBaseHistogram

annotation, dimension, entries, mapBinNumber, setAnnotation, setTitle, title

Methods inherited from class hep.aida.ref.ManagedObject

isFillable, name, setFillable, setName, type, typeForClass

Methods inherited from class hep.aida.ref.event.AIDAObservable

addListener, isConnected, removeAllListeners, removeListener, setConnected, setValid, setValidForAll

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hep.aida.IBaseHistogram

annotation, dimension, entries, setTitle, title

Methods inherited from interface hep.aida.ref.event.IsObservable

addListener, removeAllListeners, removeListener, setValid

Methods inherited from interface hep.aida.ref.event.Connectable

isConnected, setConnected

Field Detail

CLOUD_ARRAY_ENTRIES

public static final int CLOUD_ARRAY_ENTRIES

See Also:

Constant Field Values

Method Detail

reset

public void reset()

Reset the histogram; as if just created.

Specified by:

reset in interface IBaseHistogram

Overrides:

reset in class AbstractBaseHistogram

sumOfWeights

public abstract double sumOfWeights()

Get the sum of weights of of all the entries

Specified by:

sumOfWeights in interface ICloud

Returns:

The sum of the weights of all the entries.

convertToHistogram

public abstract void convertToHistogram()

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

Specified by:

convertToHistogram in interface ICloud

isConverted

public abstract boolean isConverted()

Check if the ICloud has been converted to an IHistogram.

Specified by:

isConverted in interface ICloud

Returns:

true if it has been converted.

scale

public abstract void scale(double scaleFactor)

Scale the weights by a given factor.

Specified by:

scale in interface ICloud

Parameters:

scaleFactor - The scale factor.

maxEntries

public int maxEntries()

Get the maximum number of entries after which the Cloud will convert to an Histogram.

Specified by:

maxEntries in interface ICloud

Returns:

The maximum number of entries.

getOptions

public String getOptions()

Get the options with which the Cloud was created.

Returns:

The String of options.

initCloud

public void initCloud(int maxEntries,
                      String options)

nanEntries

public int nanEntries()

Description copied from class: AbstractBaseHistogram

Number of entries whose coordinate or weight is NaN. Such entries are counted as allEntries but don't contribute to the statistics.

Specified by:

nanEntries in interface IBaseHistogram

Specified by:

nanEntries in class AbstractBaseHistogram

Returns:

The number of entries whose value or weight is NaN.