IHistogram
hep.aida

Interface IHistogram

    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      intallEntries()
      Sum of the entries in all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW.
      doubleequivalentBinEntries()
      Number of equivalent entries, i.e.
      intextraEntries()
      Number of entries in the UNDERFLOW and OVERFLOW bins.
      doublemaxBinHeight()
      Maximum height of the in-range bins, i.e.
      doubleminBinHeight()
      Minimum height of the in-range bins, i.e.
      voidscale(double scaleFactor)
      Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor.
      doublesumAllBinHeights()
      Sum of the heights of all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW.
      doublesumBinHeights()
      Sum of in-range bin heights in the IHistogram, UNDERFLOW and OVERFLOW bins are excluded.
      doublesumExtraBinHeights()
      Sum of heights in the UNDERFLOW and OVERFLOW bins.
    • Method Detail

      • allEntries

        int allEntries()
        Sum of the entries in all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW. This is equivalent to the number of times the method fill was invoked, including the entries containing NaN.
        Returns:
        The sum of all the entries.
      • extraEntries

        int extraEntries()
        Number of entries in the UNDERFLOW and OVERFLOW bins.
        Returns:
        The number of entries outside the range of the IHistogram.
      • equivalentBinEntries

        double equivalentBinEntries()
        Number of equivalent entries, i.e. SUM[ weight ] ^ 2 / SUM[ weight^2 ]
        Returns:
        The number of equivalent entries.
      • sumBinHeights

        double sumBinHeights()
        Sum of in-range bin heights in the IHistogram, UNDERFLOW and OVERFLOW bins are excluded.
        Returns:
        The sum of the in-range bins heights.
      • sumAllBinHeights

        double sumAllBinHeights()
        Sum of the heights of all the IHistogram's bins, i.e in-range bins, UNDERFLOW and OVERFLOW.
        Returns:
        The sum of all the bins heights.
      • sumExtraBinHeights

        double sumExtraBinHeights()
        Sum of heights in the UNDERFLOW and OVERFLOW bins.
        Returns:
        The sum of the heights of the out-of-range bins.
      • minBinHeight

        double minBinHeight()
        Minimum height of the in-range bins, i.e. not considering the UNDERFLOW and OVERFLOW bins.
        Returns:
        The minimum height among the in-range bins.
      • maxBinHeight

        double maxBinHeight()
        Maximum height of the in-range bins, i.e. not considering the UNDERFLOW and OVERFLOW bins.
        Returns:
        The maximum height among the in-range bins.
      • scale

        void scale(double scaleFactor)           throws IllegalArgumentException
        Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor.
        Parameters:
        scaleFactor - The scale factor.
        Throws:
        IllegalArgumentException - If the scale factor is negative.

SCaVis 2.1 © jWork.ORG