Profile2D
hep.aida.ref.histogram

Class Profile2D

    • Constructor Detail

      • Profile2D

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

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

      • binMeanX

        public double binMeanX(int indexX,              int indexY)
        Description copied from interface: IProfile2D
        The weighted mean along x of a given bin.
        Specified by:
        binMeanX in interface IProfile2D
        Parameters:
        indexX - The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        indexY - The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The mean of the corresponding bin along the x axis.
      • binMeanY

        public double binMeanY(int indexX,              int indexY)
        Description copied from interface: IProfile2D
        The weighted mean along y of a given bin.
        Specified by:
        binMeanY in interface IProfile2D
        Parameters:
        indexX - The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        indexY - The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The mean of the corresponding bin along the x axis.
      • binEntries

        public int binEntries(int indexX,             int indexY)
        Description copied from interface: IProfile2D
        The number of entries (ie the number of times fill was called for this bin).
        Specified by:
        binEntries in interface IProfile2D
        Parameters:
        indexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.
        indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.
      • binEntriesX

        public int binEntriesX(int indexX)
        Description copied from interface: IProfile2D
        Equivalent to projectionX().binEntries(indexX).
        Specified by:
        binEntriesX in interface IProfile2D
      • binEntriesY

        public int binEntriesY(int indexY)
        Description copied from interface: IProfile2D
        Equivalent to projectionY().binEntries(indexY).
        Specified by:
        binEntriesY in interface IProfile2D
      • binError

        public double binError(int indexX,              int indexY)
        Description copied from interface: IProfile2D
        The error on this bin.
        Specified by:
        binError in interface IProfile2D
        Parameters:
        indexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.
        indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.
      • binHeight

        public double binHeight(int indexX,               int indexY)
        Description copied from interface: IProfile2D
        Total height of the corresponding bin (ie the sum of the weights in this bin).
        Specified by:
        binHeight in interface IProfile2D
        Parameters:
        indexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.
        indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.
      • binHeightX

        public double binHeightX(int indexX)
        Description copied from interface: IProfile2D
        Equivalent to projectionX().binHeight(indexX).
        Specified by:
        binHeightX in interface IProfile2D
      • binHeightY

        public double binHeightY(int indexY)
        Description copied from interface: IProfile2D
        Equivalent to projectionY().binHeight(indexY).
        Specified by:
        binHeightY in interface IProfile2D
      • binRms

        public double binRms(int indexX,            int indexY)
        Description copied from interface: IProfile2D
        The spread (RMS) of this bin.
        Specified by:
        binRms in interface IProfile2D
        Parameters:
        indexX - the x bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.
        indexY - the y bin number (0...Ny-1) or OVERFLOW or UNDERFLOW.
      • meanX

        public double meanX()
        Description copied from interface: IProfile2D
        Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the X axis.
        Specified by:
        meanX in interface IProfile2D
      • meanY

        public double meanY()
        Description copied from interface: IProfile2D
        Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the Y axis.
        Specified by:
        meanY in interface IProfile2D
      • rmsX

        public double rmsX()
        Description copied from interface: IProfile2D
        Returns the rms of the in-range data of the profile as calculated on filling-time projected on the X axis.
        Specified by:
        rmsX in interface IProfile2D
      • rmsY

        public double rmsY()
        Description copied from interface: IProfile2D
        Returns the rms of the in-range data of the profile as calculated on filling-time projected on the Y axis.
        Specified by:
        rmsY in interface IProfile2D
      • 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.
      • 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.
      • 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.
      • 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.
      • initProfile2D

        public void initProfile2D(IAxis xAxis,                 IAxis yAxis)
      • initProfile2D

        public void initProfile2D(IAxis xAxis,                 IAxis yAxis,                 String options)
      • setRmsX

        public void setRmsX(double rmsX)
      • setRmsY

        public void setRmsY(double rmsY)
      • setMeanX

        public void setMeanX(double meanX)
      • setMeanY

        public void setMeanY(double meanY)
      • setNEntries

        public void setNEntries(int entries)
      • setValidEntries

        public void setValidEntries(int entries)
      • setContents

        public void setContents(double[][] heights,               double[][] errors,               int[][] entries,               double[][] rmss,               double[][] meanXs,               double[][] meanYs)

SCaVis 2.0 © jWork.ORG