IProfile2D
hep.aida

Interface IProfile2D

    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      voidadd(IProfile2D h)
      Modifies this profile by adding the contents of profile to it.
      intbinEntries(int indexX, int indexY)
      The number of entries (ie the number of times fill was called for this bin).
      intbinEntriesX(int indexX)
      Equivalent to projectionX().binEntries(indexX).
      intbinEntriesY(int indexY)
      Equivalent to projectionY().binEntries(indexY).
      doublebinError(int indexX, int indexY)
      The error on this bin.
      doublebinHeight(int indexX, int indexY)
      Total height of the corresponding bin (ie the sum of the weights in this bin).
      doublebinHeightX(int indexX)
      Equivalent to projectionX().binHeight(indexX).
      doublebinHeightY(int indexY)
      Equivalent to projectionY().binHeight(indexY).
      doublebinMeanX(int indexX, int indexY)
      The weighted mean along x of a given bin.
      doublebinMeanY(int indexX, int indexY)
      The weighted mean along y of a given bin.
      doublebinRms(int indexX, int indexY)
      The spread (RMS) of this bin.
      intcoordToIndexX(double coordX)
      Convenience method, equivalent to xAxis().coordToIndex(coord).
      intcoordToIndexY(double coordY)
      Convenience method, equivalent to yAxis().coordToIndex(coord).
      voidfill(double x, double y, double z)
      Fill the IProfile2D.
      voidfill(double x, double y, double z, double weight)
      Fill the IProfile2D.
      doublemeanX()
      Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the X axis.
      doublemeanY()
      Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the Y axis.
      doublermsX()
      Returns the rms of the in-range data of the profile as calculated on filling-time projected on the X axis.
      doublermsY()
      Returns the rms of the in-range data of the profile as calculated on filling-time projected on the Y axis.
      IAxisxAxis()
      Return the X axis.
      IAxisyAxis()
      Return the Y axis.
    • Method Detail

      • fill

        void fill(double x,        double y,        double z)          throws IllegalArgumentException
        Fill the IProfile2D. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.
        Throws:
        IllegalArgumentException
      • fill

        void fill(double x,        double y,        double z,        double weight)          throws IllegalArgumentException
        Fill the IProfile2D. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.
        Throws:
        IllegalArgumentException
      • binMeanX

        double binMeanX(int indexX,              int indexY)                throws IllegalArgumentException
        The weighted mean along x of a given bin.
        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.
        Throws:
        IllegalArgumentException - If the indexes are not a valid bin number.
      • binMeanY

        double binMeanY(int indexX,              int indexY)                throws IllegalArgumentException
        The weighted mean along y of a given bin.
        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.
        Throws:
        IllegalArgumentException - If the indexes are not a valid bin number.
      • binEntries

        int binEntries(int indexX,             int indexY)
        The number of entries (ie the number of times fill was called for this bin).
        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

        int binEntriesX(int indexX)
        Equivalent to projectionX().binEntries(indexX).
      • binEntriesY

        int binEntriesY(int indexY)
        Equivalent to projectionY().binEntries(indexY).
      • binHeight

        double binHeight(int indexX,               int indexY)
        Total height of the corresponding bin (ie the sum of the weights in this bin).
        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

        double binHeightX(int indexX)
        Equivalent to projectionX().binHeight(indexX).
      • binHeightY

        double binHeightY(int indexY)
        Equivalent to projectionY().binHeight(indexY).
      • binError

        double binError(int indexX,              int indexY)
        The error on this bin.
        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.
      • binRms

        double binRms(int indexX,            int indexY)
        The spread (RMS) of this bin.
        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

        double meanX()
        Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the X axis.
      • meanY

        double meanY()
        Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the Y axis.
      • rmsX

        double rmsX()
        Returns the rms of the in-range data of the profile as calculated on filling-time projected on the X axis.
      • rmsY

        double rmsY()
        Returns the rms of the in-range data of the profile as calculated on filling-time projected on the Y axis.
      • xAxis

        IAxis xAxis()
        Return the X axis.
      • yAxis

        IAxis yAxis()
        Return the Y axis.
      • coordToIndexX

        int coordToIndexX(double coordX)
        Convenience method, equivalent to xAxis().coordToIndex(coord).
        See Also:
        IAxis.coordToIndex(double)
      • coordToIndexY

        int coordToIndexY(double coordY)
        Convenience method, equivalent to yAxis().coordToIndex(coord).
        See Also:
        IAxis.coordToIndex(double)

SCaVis 1.7 © jWork.org