IHistogram1D
hep.aida

Interface IHistogram1D

    • Method Detail

      • fill

        void fill(double x)          throws IllegalArgumentException
        Fill the IHistogram1D with a value and the corresponding weight. If either the value or the weight is NaN the entry will be recorded but it will not contribue to the statistics.
        Parameters:
        x - The value to be filled in.
        Throws:
        IllegalArgumentException - If the weight is <0 or >1 (?).
      • fill

        void fill(double x,        double weight)          throws IllegalArgumentException
        Fill the IHistogram1D with a value and the corresponding weight. If either the value or the weight is NaN the entry will be recorded but it will not contribue to the statistics.
        Parameters:
        x - The value to be filled in.
        weight - The corresponding weight (by default 1).
        Throws:
        IllegalArgumentException - If the weight is <0 or >1 (?).
      • binMean

        double binMean(int index)               throws IllegalArgumentException
        The weighted mean of a bin.
        Parameters:
        index - The bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The mean of the corresponding bin.
        Throws:
        IllegalArgumentException - If index is not a valid bin number.
      • binEntries

        int binEntries(int index)               throws IllegalArgumentException
        Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
        Parameters:
        index - The bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The number of entries in the corresponding bin.
        Throws:
        IllegalArgumentException - If index is not a valid bin number.
      • binHeight

        double binHeight(int index)                 throws IllegalArgumentException
        Total height of the corresponding bin (ie the sum of the weights in this bin).
        Parameters:
        index - The bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The height of the corresponding bin.
        Throws:
        IllegalArgumentException - If index is not a valid bin number.
      • binError

        double binError(int index)                throws IllegalArgumentException
        The error of a given bin.
        Parameters:
        index - The bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The error on the corresponding bin.
        Throws:
        IllegalArgumentException - If index is not a valid bin number.
      • mean

        double mean()
        The mean of the in-range data of the IHistogram1D.
        Returns:
        The mean of the IHistogram1D.
      • rms

        double rms()
        The RMS of the in-range data of the IHistogram1D.
        Returns:
        The RMS if the IHistogram1D.
      • axis

        IAxis axis()
        Get the x axis of the IHistogram1D.
        Returns:
        The x coordinate IAxis.
      • coordToIndex

        int coordToIndex(double coord)
        Get the bin number corresponding to a given coordinate along the x axis. This is a convenience method, equivalent to axis().coordToIndex(coord).
        Parameters:
        coord - The coordinalte along the x axis.
        Returns:
        The corresponding bin number.
        See Also:
        IAxis.coordToIndex(double)

SCaVis 2.2 © jWork.ORG