FloatIHistogram3D
hep.aida.tfloat

Interface FloatIHistogram3D

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


    public interface FloatIHistogram3Dextends FloatIHistogram
    A Java interface corresponding to the AIDA 3D 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, int indexZ)
      The number of entries (ie the number of times fill was called for this bin).
      floatbinError(int indexX, int indexY, int indexZ)
      The error on this bin.
      floatbinHeight(int indexX, int indexY, int indexZ)
      Total height of the corresponding bin (ie the sum of the weights in this bin).
      voidfill(float x, float y, float z)
      Fill the histogram with weight 1; equivalent to fill(x,y,z,1)..
      voidfill(float x, float y, float z, 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.
      floatmeanZ()
      Returns the mean of the histogram, as calculated on filling-time projected on the Z axis.
      int[]minMaxBins()
      Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
      FloatIHistogram2DprojectionXY()
      Create a projection parallel to the XY plane.
      FloatIHistogram2DprojectionXZ()
      Create a projection parallel to the XZ plane.
      FloatIHistogram2DprojectionYZ()
      Create a projection parallel to the YZ plane.
      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.
      floatrmsZ()
      Returns the rms of the histogram as calculated on filling-time projected on the Z axis.
      FloatIHistogram2DsliceXY(int indexZ)
      Create a slice parallel to the XY plane at bin indexZ and one bin wide.
      FloatIHistogram2DsliceXY(int indexZ1, int indexZ2)
      Create a slice parallel to the XY plane, between "indexZ1" and "indexZ2" (inclusive).
      FloatIHistogram2DsliceXZ(int indexY)
      Create a slice parallel to the XZ plane at bin indexY and one bin wide.
      FloatIHistogram2DsliceXZ(int indexY1, int indexY2)
      Create a slice parallel to the XZ plane, between "indexY1" and "indexY2" (inclusive).
      FloatIHistogram2DsliceYZ(int indexX)
      Create a slice parallel to the YZ plane at bin indexX and one bin wide.
      FloatIHistogram2DsliceYZ(int indexX1, int indexX2)
      Create a slice parallel to the YZ plane, between "indexX1" and "indexX2" (inclusive).
      FloatIAxisxAxis()
      Return the X axis.
      FloatIAxisyAxis()
      Return the Y axis.
      FloatIAxiszAxis()
      Return the Z axis.
    • Method Detail

      • binEntries

        int binEntries(int indexX,             int indexY,             int indexZ)
        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.
        indexZ - the z bin number (0...Nz-1) or OVERFLOW or UNDERFLOW.
      • binError

        float binError(int indexX,             int indexY,             int indexZ)
        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.
        indexZ - the z bin number (0...Nz-1) or OVERFLOW or UNDERFLOW.
      • binHeight

        float binHeight(int indexX,              int indexY,              int indexZ)
        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.
        indexZ - the z bin number (0...Nz-1) or OVERFLOW or UNDERFLOW.
      • fill

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

        void fill(float x,        float y,        float z,        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.
      • meanZ

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

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

        FloatIHistogram2D projectionXY()
        Create a projection parallel to the XY plane. Equivalent to sliceXY(UNDERFLOW,OVERFLOW).
      • projectionXZ

        FloatIHistogram2D projectionXZ()
        Create a projection parallel to the XZ plane. Equivalent to sliceXZ(UNDERFLOW,OVERFLOW).
      • projectionYZ

        FloatIHistogram2D projectionYZ()
        Create a projection parallel to the YZ plane. Equivalent to sliceYZ(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.
      • rmsZ

        float rmsZ()
        Returns the rms of the histogram as calculated on filling-time projected on the Z axis.
      • sliceXY

        FloatIHistogram2D sliceXY(int indexZ)
        Create a slice parallel to the XY plane at bin indexZ and one bin wide. Equivalent to sliceXY(indexZ,indexZ).
      • sliceXY

        FloatIHistogram2D sliceXY(int indexZ1,                        int indexZ2)
        Create a slice parallel to the XY plane, between "indexZ1" and "indexZ2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created.
      • sliceXZ

        FloatIHistogram2D sliceXZ(int indexY)
        Create a slice parallel to the XZ plane at bin indexY and one bin wide. Equivalent to sliceXZ(indexY,indexY).
      • sliceXZ

        FloatIHistogram2D sliceXZ(int indexY1,                        int indexY2)
        Create a slice parallel to the XZ plane, between "indexY1" and "indexY2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created.
      • sliceYZ

        FloatIHistogram2D sliceYZ(int indexX)
        Create a slice parallel to the YZ plane at bin indexX and one bin wide. Equivalent to sliceYZ(indexX,indexX).
      • sliceYZ

        FloatIHistogram2D sliceYZ(int indexX1,                        int indexX2)
        Create a slice parallel to the YZ plane, between "indexX1" and "indexX2" (inclusive). The returned IHistogram2D represents an instantaneous snapshot of the histogram at the time the slice was created.

SCaVis 2.2 © jWork.ORG