IHistogram3D
hep.aida

Interface IHistogram3D

    • Method Summary

      Methods 
      Modifier and TypeMethod and Description
      voidadd(IHistogram3D hist)
      Add to this IHistogram3D the contents of another IHistogram3D.
      intbinEntries(int indexX, int indexY, int indexZ)
      Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
      intbinEntriesX(int index)
      Sum of all the entries of the bins along a given x bin.
      intbinEntriesY(int index)
      Sum of all the entries of the bins along a given y bin.
      intbinEntriesZ(int index)
      Sum of all the entries of the bins along a given z bin.
      doublebinError(int indexX, int indexY, int indexZ)
      The error of a given bin.
      doublebinHeight(int indexX, int indexY, int indexZ)
      Total height of a give bin (ie the sum of the weights in this bin).
      doublebinHeightX(int index)
      Sum of all the heights of the bins along a given x bin.
      doublebinHeightY(int index)
      Sum of all the heights of the bins along a given y bin.
      doublebinHeightZ(int index)
      Sum of all the heights of the bins along a given z bin.
      doublebinMeanX(int indexX, int indexY, int indexZ)
      The weighted mean along the x axis of a given bin.
      doublebinMeanY(int indexX, int indexY, int indexZ)
      The weighted mean the y axis of a given bin.
      doublebinMeanZ(int indexX, int indexY, int indexZ)
      The weighted mean the z axis of a given bin.
      intcoordToIndexX(double coord)
      Get the bin number corresponding to a given coordinate along the x axis.
      intcoordToIndexY(double coord)
      Get the bin number corresponding to a given coordinate along the y axis.
      intcoordToIndexZ(double coord)
      Get the bin number corresponding to a given coordinate along the z axis.
      voidfill(double x, double y, double z)
      Fill the IHistogram3D with a triplet of values and the corresponding weight.
      voidfill(double x, double y, double z, double weight)
      Fill the IHistogram3D with a triplet of values and the corresponding weight.
      doublemeanX()
      The mean of the in-range data of the IHistogram3D along the x axis.
      doublemeanY()
      The mean of the in-range data of the IHistogram3D along the y axis.
      doublemeanZ()
      The mean of the in-range data of the IHistogram3D along the z axis.
      doublermsX()
      The RMS of the in-range data of the IHistogram3D along the x axis.
      doublermsY()
      The RMS of the in-range data of the IHistogram3D along the y axis.
      doublermsZ()
      The RMS of the in-range data of the IHistogram3D along the z axis.
      IAxisxAxis()
      Get the x axis of the IHistogram3D.
      IAxisyAxis()
      Get the y axis of the IHistogram3D.
      IAxiszAxis()
      Get the z axis of the IHistogram3D.
    • Method Detail

      • fill

        void fill(double x,        double y,        double z)          throws IllegalArgumentException
        Fill the IHistogram3D with a triplet of values and the corresponding weight. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.
        Parameters:
        x - The x value to be filled in.
        y - The y value to be filled in.
        z - The z value to be filled in.
        Throws:
        IllegalArgumentException - If the weight is <0 or >1 (?).
      • fill

        void fill(double x,        double y,        double z,        double weight)          throws IllegalArgumentException
        Fill the IHistogram3D with a triplet of values and the corresponding weight. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.
        Parameters:
        x - The x value to be filled in.
        y - The y value to be filled in.
        z - The z value to be filled in.
        weight - The corresponding weight (by default 1).
        Throws:
        IllegalArgumentException - If the weight is <0 or >1 (?).
      • binMeanX

        double binMeanX(int indexX,              int indexY,              int indexZ)                throws IllegalArgumentException
        The weighted mean along the x axis 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.
        indexZ - The z 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,              int indexZ)                throws IllegalArgumentException
        The weighted mean the y axis 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.
        indexZ - The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The mean of the corresponding bin along the y axis.
        Throws:
        IllegalArgumentException - If the indexes are not a valid bin number.
      • binMeanZ

        double binMeanZ(int indexX,              int indexY,              int indexZ)                throws IllegalArgumentException
        The weighted mean the z axis 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.
        indexZ - The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The mean of the corresponding bin along the z axis.
        Throws:
        IllegalArgumentException - If the indexes are not a valid bin number.
      • binEntries

        int binEntries(int indexX,             int indexY,             int indexZ)               throws IllegalArgumentException
        Number of entries in the corresponding bin (ie the number of times fill was called for this 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.
        indexZ - The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The number of entries in the corresponding bin.
        Throws:
        IllegalArgumentException - If the indexes are not a valid bin number.
      • binEntriesX

        int binEntriesX(int index)                throws IllegalArgumentException
        Sum of all the entries of the bins along a given x bin. This is equivalent to projectionXY().binEntriesX(index).
        Parameters:
        index - The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The number of entries in the corresponding set of bins.
        Throws:
        IllegalArgumentException - If the index id not a valid bin number.
      • binEntriesY

        int binEntriesY(int index)                throws IllegalArgumentException
        Sum of all the entries of the bins along a given y bin. This is equivalent to projectionXY().binEntriesY(index).
        Parameters:
        index - The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The number of entries in the corresponding set of bins.
        Throws:
        IllegalArgumentException - If the index id not a valid bin number.
      • binEntriesZ

        int binEntriesZ(int index)                throws IllegalArgumentException
        Sum of all the entries of the bins along a given z bin. This is equivalent to projectionXZ().binEntriesZ(index).
        Parameters:
        index - The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The number of entries in the corresponding set of bins.
        Throws:
        IllegalArgumentException - If the index id not a valid bin number.
      • binHeight

        double binHeight(int indexX,               int indexY,               int indexZ)                 throws IllegalArgumentException
        Total height of a give bin (ie the sum of the weights in this 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.
        indexZ - The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The height of the corresponding bin.
        Throws:
        IllegalArgumentException - If the indexes are not a valid bin number.
      • binHeightX

        double binHeightX(int index)                  throws IllegalArgumentException
        Sum of all the heights of the bins along a given x bin. This is equivalent to projectionXY().binHeightX(index).
        Parameters:
        index - The x bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The sum of the heights in the corresponding set of bins.
        Throws:
        IllegalArgumentException - If the index id not a valid bin number.
      • binHeightY

        double binHeightY(int index)                  throws IllegalArgumentException
        Sum of all the heights of the bins along a given y bin. This is equivalent to projectionXY().binHeightY(index).
        Parameters:
        index - The y bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The sum of the heights in the corresponding set of bins.
        Throws:
        IllegalArgumentException - If the index id not a valid bin number.
      • binHeightZ

        double binHeightZ(int index)                  throws IllegalArgumentException
        Sum of all the heights of the bins along a given z bin. This is equivalent to projectionXZ().binHeightZ(index).
        Parameters:
        index - The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The sum of the heights in the corresponding set of bins.
        Throws:
        IllegalArgumentException - If the index id not a valid bin number.
      • binError

        double binError(int indexX,              int indexY,              int indexZ)                throws IllegalArgumentException
        The error 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.
        indexZ - The z bin number (0...N-1) or OVERFLOW or UNDERFLOW.
        Returns:
        The error on the corresponding bin.
        Throws:
        IllegalArgumentException - If the indexes are not a valid bin number.
      • meanX

        double meanX()
        The mean of the in-range data of the IHistogram3D along the x axis.
        Returns:
        The mean of the IHistogram3D along the x axis.
      • meanY

        double meanY()
        The mean of the in-range data of the IHistogram3D along the y axis.
        Returns:
        The mean of the IHistogram3D along the y axis.
      • meanZ

        double meanZ()
        The mean of the in-range data of the IHistogram3D along the z axis.
        Returns:
        The mean of the IHistogram3D along the z axis.
      • rmsX

        double rmsX()
        The RMS of the in-range data of the IHistogram3D along the x axis.
        Returns:
        The RMS if the IHistogram3D along the x axis.
      • rmsY

        double rmsY()
        The RMS of the in-range data of the IHistogram3D along the y axis.
        Returns:
        The RMS if the IHistogram3D along the y axis.
      • rmsZ

        double rmsZ()
        The RMS of the in-range data of the IHistogram3D along the z axis.
        Returns:
        The RMS if the IHistogram3D along the z axis.
      • xAxis

        IAxis xAxis()
        Get the x axis of the IHistogram3D.
        Returns:
        The x coordinate IAxis.
      • yAxis

        IAxis yAxis()
        Get the y axis of the IHistogram3D.
        Returns:
        The y coordinate IAxis.
      • zAxis

        IAxis zAxis()
        Get the z axis of the IHistogram3D.
        Returns:
        The z coordinate IAxis.
      • coordToIndexX

        int coordToIndexX(double coord)
        Get the bin number corresponding to a given coordinate along the x axis. This is a convenience method, equivalent to xAxis().coordToIndex(coord).
        Parameters:
        coord - The coordinalte along the x axis.
        Returns:
        The corresponding bin number.
        See Also:
        IAxis.coordToIndex(double)
      • coordToIndexY

        int coordToIndexY(double coord)
        Get the bin number corresponding to a given coordinate along the y axis. This is a convenience method, equivalent to yAxis().coordToIndex(coord).
        Parameters:
        coord - The coordinalte along the y axis.
        Returns:
        The corresponding bin number.
        See Also:
        IAxis.coordToIndex(double)
      • coordToIndexZ

        int coordToIndexZ(double coord)
        Get the bin number corresponding to a given coordinate along the z axis. This is a convenience method, equivalent to zAxis().coordToIndex(coord).
        Parameters:
        coord - The coordinalte along the z axis.
        Returns:
        The corresponding bin number.
        See Also:
        IAxis.coordToIndex(double)

SCaVis 1.8 © jWork.org