Package hep.aida

Interface IHistogram

All Superinterfaces:
Serializable
All Known Subinterfaces:
IHistogram1D, IHistogram2D, IHistogram3D
All Known Implementing Classes:
AbstractHistogram1D, AbstractHistogram2D, AbstractHistogram3D, Histogram, Histogram1D, Histogram2D, Histogram3D

public interface IHistogram extends Serializable
A common base interface for IHistogram1D, IHistogram2D and IHistogram3D.
Version:
1.0, 23/03/2000
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    Constant specifying the overflow bin (can be passed to any method expecting a bin number).
    static final long
     
    static final int
    Constant specifying the underflow bin (can be passed to any method expecting a bin number).
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Number of all entries in all (both in-range and under/overflow) bins in the histogram.
    int
    Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.
    int
    Number of in-range entries in the histogram.
    double
    Number of equivalent entries.
    int
    Number of under and overflow entries in the histogram.
    void
    Reset contents; as if just constructed.
    double
    Sum of all (both in-range and under/overflow) bin heights in the histogram.
    double
    Sum of in-range bin heights in the histogram.
    double
    Sum of under/overflow bin heights in the histogram.
    Title of the histogram (will be set only in the constructor).
  • Field Details

    • OVERFLOW

      static final int OVERFLOW
      Constant specifying the overflow bin (can be passed to any method expecting a bin number).
      See Also:
    • UNDERFLOW

      static final int UNDERFLOW
      Constant specifying the underflow bin (can be passed to any method expecting a bin number).
      See Also:
    • serialVersionUID

      static final long serialVersionUID
      See Also:
  • Method Details

    • allEntries

      int allEntries()
      Number of all entries in all (both in-range and under/overflow) bins in the histogram.
    • dimensions

      int dimensions()
      Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.
    • entries

      int entries()
      Number of in-range entries in the histogram.
    • equivalentBinEntries

      double equivalentBinEntries()
      Number of equivalent entries.
      Returns:
      SUM[ weight ] ^ 2 / SUM[ weight^2 ].
    • extraEntries

      int extraEntries()
      Number of under and overflow entries in the histogram.
    • reset

      void reset()
      Reset contents; as if just constructed.
    • sumAllBinHeights

      double sumAllBinHeights()
      Sum of all (both in-range and under/overflow) bin heights in the histogram.
    • sumBinHeights

      double sumBinHeights()
      Sum of in-range bin heights in the histogram.
    • sumExtraBinHeights

      double sumExtraBinHeights()
      Sum of under/overflow bin heights in the histogram.
    • title

      String title()
      Title of the histogram (will be set only in the constructor).