AIDA API
Version 3.3

hep.aida
Interface IHistogram3D

All Superinterfaces:
IBaseHistogram, IHistogram

public interface IHistogram3D
extends IHistogram

User level interface to 3D Histogram.

Author:
The AIDA team (http://aida.freehep.org/)

Method Summary
 void add(IHistogram3D hist)
          Add to this IHistogram3D the contents of another IHistogram3D.
 int binEntries(int indexX, int indexY, int indexZ)
          Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
 int binEntriesX(int index)
          Sum of all the entries of the bins along a given x bin.
 int binEntriesY(int index)
          Sum of all the entries of the bins along a given y bin.
 int binEntriesZ(int index)
          Sum of all the entries of the bins along a given z bin.
 double binError(int indexX, int indexY, int indexZ)
          The error of a given bin.
 double binHeight(int indexX, int indexY, int indexZ)
          Total height of a give bin (ie the sum of the weights in this bin).
 double binHeightX(int index)
          Sum of all the heights of the bins along a given x bin.
 double binHeightY(int index)
          Sum of all the heights of the bins along a given y bin.
 double binHeightZ(int index)
          Sum of all the heights of the bins along a given z bin.
 double binMeanX(int indexX, int indexY, int indexZ)
          The weighted mean along the x axis of a given bin.
 double binMeanY(int indexX, int indexY, int indexZ)
          The weighted mean the y axis of a given bin.
 double binMeanZ(int indexX, int indexY, int indexZ)
          The weighted mean the z axis of a given bin.
 int coordToIndexX(double coord)
          Get the bin number corresponding to a given coordinate along the x axis.
 int coordToIndexY(double coord)
          Get the bin number corresponding to a given coordinate along the y axis.
 int coordToIndexZ(double coord)
          Get the bin number corresponding to a given coordinate along the z axis.
 void fill(double x, double y, double z)
          Fill the IHistogram3D with a triplet of values and the corresponding weight.
 void fill(double x, double y, double z, double weight)
          Fill the IHistogram3D with a triplet of values and the corresponding weight.
 double meanX()
          The mean of the in-range data of the IHistogram3D along the x axis.
 double meanY()
          The mean of the in-range data of the IHistogram3D along the y axis.
 double meanZ()
          The mean of the in-range data of the IHistogram3D along the z axis.
 double rmsX()
          The RMS of the in-range data of the IHistogram3D along the x axis.
 double rmsY()
          The RMS of the in-range data of the IHistogram3D along the y axis.
 double rmsZ()
          The RMS of the in-range data of the IHistogram3D along the z axis.
 IAxis xAxis()
          Get the x axis of the IHistogram3D.
 IAxis yAxis()
          Get the y axis of the IHistogram3D.
 IAxis zAxis()
          Get the z axis of the IHistogram3D.
 
Methods inherited from interface hep.aida.IHistogram
allEntries, equivalentBinEntries, extraEntries, maxBinHeight, minBinHeight, scale, sumAllBinHeights, sumBinHeights, sumExtraBinHeights
 
Methods inherited from interface hep.aida.IBaseHistogram
annotation, dimension, entries, nanEntries, reset, setTitle, title
 

Method Detail

fill

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public IAxis xAxis()
Get the x axis of the IHistogram3D.

Returns:
The x coordinate IAxis.

yAxis

public IAxis yAxis()
Get the y axis of the IHistogram3D.

Returns:
The y coordinate IAxis.

zAxis

public IAxis zAxis()
Get the z axis of the IHistogram3D.

Returns:
The z coordinate IAxis.

coordToIndexX

public 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

public 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

public 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)

add

public void add(IHistogram3D hist)
         throws IllegalArgumentException
Add to this IHistogram3D the contents of another IHistogram3D.

Parameters:
hist - The IHistogram3D to be added to this IHistogram3D.
Throws:
IllegalArgumentException - If the IHistogram3Ds binnings are incompatible.

AIDA API
Version 3.3

Copyright © 2000-2004 AIDA Team, All Rights Reserved.