Profile1D
hep.aida.ref.histogram

Class Profile1D

    • Constructor Detail

      • Profile1D

        public Profile1D()
        Create a 1-dimensional Profile.
      • Profile1D

        public Profile1D(String name,         String title,         IAxis axis)
        Create a 1-dimensional Profile.
        Parameters:
        name - The name of the Profile as a ManagedObject.
        title - The title of the Profile.
        axis - The x-axis of the Profile.
    • Method Detail

      • allEntries

        public int allEntries()
        Description copied from interface: IProfile
        Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.
        Specified by:
        allEntries in interface IProfile
        Returns:
        The sum of all the entries.
      • extraEntries

        public int extraEntries()
        Description copied from interface: IProfile
        Get the number of entries in the underflow and overflow bins.
        Specified by:
        extraEntries in interface IProfile
        Returns:
        The numer of entries in the out-of-range bins.
      • sumAllBinHeights

        public double sumAllBinHeights()
        Description copied from interface: IProfile
        Get the sum of all the bins heights (including underflow and overflow bin).
        Specified by:
        sumAllBinHeights in interface IProfile
        Returns:
        The sum of all the bins heights.
      • sumBinHeights

        public double sumBinHeights()
        Description copied from interface: IProfile
        Get the sum of in range bin heights in the IProfile.
        Specified by:
        sumBinHeights in interface IProfile
        Returns:
        The sum of all the in-range bins heights.
      • sumExtraBinHeights

        public double sumExtraBinHeights()
        Description copied from interface: IProfile
        Get the sum of the underflow and overflow bin height.
        Specified by:
        sumExtraBinHeights in interface IProfile
        Returns:
        The sum of the out-of-range bins heights.
      • minBinHeight

        public double minBinHeight()
        Description copied from interface: IProfile
        Get the minimum height of the in-range bins.
        Specified by:
        minBinHeight in interface IProfile
        Returns:
        The minimum height among the in-range bins.
      • maxBinHeight

        public double maxBinHeight()
        Description copied from interface: IProfile
        Get the maximum height of the in-range bins.
        Specified by:
        maxBinHeight in interface IProfile
        Returns:
        The maximum height among the in-range bins.
      • fill

        public void fill(double x,        double y,        double weight)
        Description copied from interface: IProfile1D
        Fill the IProfile1D. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.
        Specified by:
        fill in interface IProfile1D
      • fill

        public void fill(double x,        double y)
        Description copied from interface: IProfile1D
        Fill the IProfile1D. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.
        Specified by:
        fill in interface IProfile1D
      • binEntries

        public int binEntries(int index)
        Description copied from interface: IProfile1D
        Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
        Specified by:
        binEntries in interface IProfile1D
        Parameters:
        index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
      • binHeight

        public double binHeight(int index)
        Description copied from interface: IProfile1D
        Total height of the corresponding bin (ie the sum of the weights in this bin).
        Specified by:
        binHeight in interface IProfile1D
        Parameters:
        index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
      • binError

        public double binError(int index)
        Description copied from interface: IProfile1D
        The error on this bin.
        Specified by:
        binError in interface IProfile1D
        Parameters:
        index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
      • binMean

        public double binMean(int index)
        Description copied from interface: IProfile1D
        The weighted mean of the corresponding bin.
        Specified by:
        binMean in interface IProfile1D
        Parameters:
        index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The mean of the corresponding bin along the x axis.
      • binRms

        public double binRms(int index)
        Description copied from interface: IProfile1D
        The spread (RMS) of a bin.
        Specified by:
        binRms in interface IProfile1D
        Parameters:
        index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
      • mean

        public double mean()
        Description copied from interface: IProfile1D
        Returns the mean of the in-range data of the profile as calculated on filling-time.
        Specified by:
        mean in interface IProfile1D
      • rms

        public double rms()
        Description copied from interface: IProfile1D
        Returns the rms of the in-range data of the profile as calculated on filling-time.
        Specified by:
        rms in interface IProfile1D
      • initProfile1D

        public void initProfile1D(IAxis axis)
      • initProfile1D

        public void initProfile1D(IAxis axis,                 String options)
      • setRms

        public void setRms(double rms)
      • setMean

        public void setMean(double mean)
      • setContents

        public void setContents(double[] heights,               double[] errors,               int[] entries,               double[] rmss,               double[] meanXs)
        Set the content of the whole Histogram at once. This is a convenience method for saving/restoring Histograms. Of the arguments below the heights, the errors and the entries array cannot be null. If the means array is null, the mean is defaulted to the geometric center of the bin. If the rms array is null, the rms is taken to be the bin width over the root of 12.
        Parameters:
        heights - The bins heights
        errors - The bins errors
        entries - The bin entries.
        rmss - The rmss of the bins
        meanXs - The mean of the bin.
      • setNEntries

        public void setNEntries(int entries)
      • setValidEntries

        public void setValidEntries(int entries)

SCaVis 2.1 © jWork.ORG