AIDA API
Version 3.3

hep.aida
Interface IBaseHistogram

All Known Subinterfaces:
ICloud, ICloud1D, ICloud2D, ICloud3D, IHistogram, IHistogram1D, IHistogram2D, IHistogram3D, IProfile, IProfile1D, IProfile2D

public interface IBaseHistogram

User level interface to Histogram. Provides the common functionality of the histogram-like classes.

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

Method Summary
 IAnnotation annotation()
          Get the IAnnotation associated with the Histogram.
 int dimension()
          Get the Histogram's dimension.
 int entries()
          Get the number of in-range entries in the Histogram.
 int nanEntries()
          Number of entries whose coordinate or weight is NaN.
 void reset()
          Reset the Histogram; as if just created.
 void setTitle(String title)
          Set the histogram title.
 String title()
          Get the Histogram's title.
 

Method Detail

title

public String title()
Get the Histogram's title.

Returns:
The Histogram's title.

setTitle

public void setTitle(String title)
              throws IllegalArgumentException
Set the histogram title.

Parameters:
title - The title.
Throws:
IllegalArgumentException - If title cannot be changed.

annotation

public IAnnotation annotation()
Get the IAnnotation associated with the Histogram.

Returns:
The IAnnotation.

dimension

public int dimension()
Get the Histogram's dimension.

Returns:
The Histogram's dimension.

reset

public void reset()
           throws RuntimeException
Reset the Histogram; as if just created.

Throws:
RuntimeException - If something goes wrong.

entries

public int entries()
Get the number of in-range entries in the Histogram.

Returns:
The number of in-range entries.

nanEntries

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

Returns:
The number of entries whose value or weight is NaN.

AIDA API
Version 3.3

Copyright © 2000-2004 AIDA Team, All Rights Reserved.