FloatIHistogram2D
hep.aida.tfloat

Interface FloatIHistogram2D

  • All Superinterfaces:
    FloatIHistogram, Serializable
    All Known Implementing Classes:
    FloatHistogram2D


    public interface FloatIHistogram2Dextends FloatIHistogram
    A Java interface corresponding to the AIDA 2D Histogram.

    Note All methods that accept a bin number as an argument will also accept the constants OVERFLOW or UNDERFLOW as the argument, and as a result give the contents of the resulting OVERFLOW or UNDERFLOW bin.

    See Also:
    AIDA
    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      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).
      floatbinError(int indexX, int indexY)
      The error on this bin.
      floatbinHeight(int indexX, int indexY)
      Total height of the corresponding bin (ie the sum of the weights in this bin).
      floatbinHeightX(int indexX)
      Equivalent to projectionX().binHeight(indexX).
      floatbinHeightY(int indexY)
      Equivalent to projectionY().binHeight(indexY).
      voidfill(float x, float y)
      Fill the histogram with weight 1.
      voidfill(float x, float y, float weight)
      Fill the histogram with specified weight.
      floatmeanX()
      Returns the mean of the histogram, as calculated on filling-time projected on the X axis.
      floatmeanY()
      Returns the mean of the histogram, as calculated on filling-time projected on the Y axis.
      int[]minMaxBins()
      Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
      FloatIHistogram1DprojectionX()
      Create a projection parallel to the X axis.
      FloatIHistogram1DprojectionY()
      Create a projection parallel to the Y axis.
      floatrmsX()
      Returns the rms of the histogram as calculated on filling-time projected on the X axis.
      floatrmsY()
      Returns the rms of the histogram as calculated on filling-time projected on the Y axis.
      FloatIHistogram1DsliceX(int indexY)
      Slice parallel to the Y axis at bin indexY and one bin wide.
      FloatIHistogram1DsliceX(int indexY1, int indexY2)
      Create a slice parallel to the axis X axis, between "indexY1" and "indexY2" (inclusive).
      FloatIHistogram1DsliceY(int indexX)
      Slice parallel to the X axis at bin indexX and one bin wide.
      FloatIHistogram1DsliceY(int indexX1, int indexX2)
      Create a slice parallel to the axis Y axis, between "indexX1" and "indexX2" (inclusive) The returned IHistogram1D represents an instantaneous snapshot of the histogram at the time the slice was created.
      FloatIAxisxAxis()
      Return the X axis.
      FloatIAxisyAxis()
      Return the Y axis.
    • Method Detail

      • 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).
      • binError

        float 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.
      • binHeight

        float 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

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

        float binHeightY(int indexY)
        Equivalent to projectionY().binHeight(indexY).
      • fill

        void fill(float x,        float y)
        Fill the histogram with weight 1.
      • fill

        void fill(float x,        float y,        float weight)
        Fill the histogram with specified weight.
      • meanX

        float meanX()
        Returns the mean of the histogram, as calculated on filling-time projected on the X axis.
      • meanY

        float meanY()
        Returns the mean of the histogram, as calculated on filling-time projected on the Y axis.
      • minMaxBins

        int[] minMaxBins()
        Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
        Returns:
        {minBinX,minBinY, maxBinX,maxBinY}.
      • projectionX

        FloatIHistogram1D projectionX()
        Create a projection parallel to the X axis. Equivalent to sliceX(UNDERFLOW,OVERFLOW).
      • projectionY

        FloatIHistogram1D projectionY()
        Create a projection parallel to the Y axis. Equivalent to sliceY(UNDERFLOW,OVERFLOW).
      • rmsX

        float rmsX()
        Returns the rms of the histogram as calculated on filling-time projected on the X axis.
      • rmsY

        float rmsY()
        Returns the rms of the histogram as calculated on filling-time projected on the Y axis.
      • sliceX

        FloatIHistogram1D sliceX(int indexY)
        Slice parallel to the Y axis at bin indexY and one bin wide. Equivalent to sliceX(indexY,indexY).
      • sliceX

        FloatIHistogram1D sliceX(int indexY1,                       int indexY2)
        Create a slice parallel to the axis X axis, between "indexY1" and "indexY2" (inclusive). The returned IHistogram1D represents an instantaneous snapshot of the histogram at the time the slice was created.
      • sliceY

        FloatIHistogram1D sliceY(int indexX)
        Slice parallel to the X axis at bin indexX and one bin wide. Equivalent to sliceY(indexX,indexX).
      • sliceY

        FloatIHistogram1D sliceY(int indexX1,                       int indexX2)
        Create a slice parallel to the axis Y axis, between "indexX1" and "indexX2" (inclusive) The returned IHistogram1D represents an instantaneous snapshot of the histogram at the time the slice was created.

SCaVis 1.8 © jWork.org