Package hep.aida.ref

Class AbstractHistogram1D

  • All Implemented Interfaces:
    IHistogram, IHistogram1D, java.io.Serializable
    Direct Known Subclasses:
    Histogram1D
    abstract class AbstractHistogram1D
extends Histogram
implements IHistogram1D
    Abstract base class extracting and implementing most of the redundancy of the interface.
    Version:
    1.0, 23/03/2000

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractHistogram1D​(java.lang.String title)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int allEntries()
      Number of all entries in all (both in-range and under/overflow) bins in the histogram.
      int dimensions()
      Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.
      int entries()
      Number of in-range entries in the histogram.
      int extraEntries()
      Number of under and overflow entries in the histogram.
      (package private) int map​(int index)
      Package private method to map from the external representation of bin number to our internal representation of bin number
      int[] minMaxBins()
      Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
      double sumAllBinHeights()
      Sum of all (both in-range and under/overflow) bin heights in the histogram.
      double sumBinHeights()
      Sum of in-range bin heights in the histogram.
      double sumExtraBinHeights()
      Sum of under/overflow bin heights in the histogram.
      IAxis xAxis()
      Returns the X Axis.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • xAxis

        protected IAxis xAxis

    • Constructor Detail

      • AbstractHistogram1D

        AbstractHistogram1D​(java.lang.String title)

    • Method Detail

      • allEntries

        public int allEntries()
        Description copied from interface: IHistogram
        Number of all entries in all (both in-range and under/overflow) bins in the histogram.
        Specified by:
        allEntries in interface IHistogram

      • dimensions

        public int dimensions()
        Description copied from interface: IHistogram
        Returns 1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.
        Specified by:
        dimensions in interface IHistogram

      • entries

        public int entries()
        Description copied from interface: IHistogram
        Number of in-range entries in the histogram.
        Specified by:
        entries in interface IHistogram

      • extraEntries

        public int extraEntries()
        Description copied from interface: IHistogram
        Number of under and overflow entries in the histogram.
        Specified by:
        extraEntries in interface IHistogram

      • map

        int map​(int index)
        Package private method to map from the external representation of bin number to our internal representation of bin number

      • minMaxBins

        public int[] minMaxBins()
        Description copied from interface: IHistogram1D
        Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
        Specified by:
        minMaxBins in interface IHistogram1D
        Returns:
        {minBin,maxBin}.

      • sumAllBinHeights

        public double sumAllBinHeights()
        Description copied from interface: IHistogram
        Sum of all (both in-range and under/overflow) bin heights in the histogram.
        Specified by:
        sumAllBinHeights in interface IHistogram

      • sumBinHeights

        public double sumBinHeights()
        Description copied from interface: IHistogram
        Sum of in-range bin heights in the histogram.
        Specified by:
        sumBinHeights in interface IHistogram

      • sumExtraBinHeights

        public double sumExtraBinHeights()
        Description copied from interface: IHistogram
        Sum of under/overflow bin heights in the histogram.
        Specified by:
        sumExtraBinHeights in interface IHistogram