hep.aida.ref.histogram
Class AbstractBaseHistogram

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

All Implemented Interfaces:

hep.aida.dev.IDevManagedObject, IBaseHistogram, IManagedObject, Connectable

Direct Known Subclasses:

Cloud, Histogram, Profile

public abstract class AbstractBaseHistogram
extends ManagedObject
implements IBaseHistogram

Constructor Summary

AbstractBaseHistogram()

AbstractBaseHistogram(String name, String title, int dimension)
Creates a new instance of BaseHistogram.

AbstractBaseHistogram(String name, String title, int dimension, String options)

Method Summary

IAnnotation	annotation() Get the IAnnotation associated with the histogram.
int	dimension() Get the dimension of the histogram.
abstract int	entries() Number of in-range entries in the histogram.
int	mapBinNumber(int index, IAxis axis) Utility method to map the bin number from the external representation (from -2 to nBins-1 where -2 is the overflow and -1 is the underflow) to the internal one (from 0 to nBins+1 where 0 is the underflow and nBins+1 if the overflow bin)
abstract int	nanEntries() Number of entries whose coordinate or weight is NaN.
void	reset() Reset the histogram; as if just created.
void	setAnnotation(IAnnotation annotation)
void	setTitle(String title) Set the histogram title.
String	title() Get the histogram 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.ref.event.Connectable

isConnected, setConnected

Constructor Detail

AbstractBaseHistogram

public AbstractBaseHistogram(String name,
                             String title,
                             int dimension)

Creates a new instance of BaseHistogram.

Parameters:

name - The name of the BaseHistogram. See ManagedObject for details.

title - The title of the BaseHistogram.

dimension - The dimension of the BaseHistogram.

AbstractBaseHistogram

public AbstractBaseHistogram()

AbstractBaseHistogram

public AbstractBaseHistogram(String name,
                             String title,
                             int dimension,
                             String options)

Method Detail

mapBinNumber

public int mapBinNumber(int index,
                        IAxis axis)

Utility method to map the bin number from the external representation (from -2 to nBins-1 where -2 is the overflow and -1 is the underflow) to the internal one (from 0 to nBins+1 where 0 is the underflow and nBins+1 if the overflow bin)

Parameters:

index - The bin number in the external representation.

axis - The axis to which the bin belongs to.

Returns:

The bin number in the internal representation.

title

public String title()

Get the histogram title.

Specified by:

title in interface IBaseHistogram

Returns:

the Histogram title.

setTitle

public void setTitle(String title)

Set the histogram title.

Specified by:

setTitle in interface IBaseHistogram

Parameters:

title - The title.

annotation

public IAnnotation annotation()

Get the IAnnotation associated with the histogram.

Specified by:

annotation in interface IBaseHistogram

Returns:

The IAnnotation.

setAnnotation

public void setAnnotation(IAnnotation annotation)

dimension

public int dimension()

Get the dimension of the histogram.

Specified by:

dimension in interface IBaseHistogram

Returns:

The Histogram's dimension.

reset

public void reset()

Reset the histogram; as if just created.

Specified by:

reset in interface IBaseHistogram

entries

public abstract int entries()

Number of in-range entries in the histogram.

Specified by:

entries in interface IBaseHistogram

Returns:

The number of in-range entries.

nanEntries

public abstract int nanEntries()

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

Returns:

The number of entries whose value or weight is NaN.