hep.aida
Interface IHistogram3D


public interface IHistogram3D
extends IHistogram

User level interface to 3D Histogram.

Version:
$Id: IHistogram3D.html,v 1.1 2002/10/08 00:51:18 tonyj Exp $
Author:
Pavel Binko, Dino Ferrero Merlino, Wolfgang Hoschek, Tony Johnson, Andreas Pfeiffer, Mark Donszelmann, Guy Barrand
Source Code:
IHistogram3D.java

Fields inherited from interface hep.aida.IConstants
OVERFLOW_BIN, UNDERFLOW_BIN, VERSION, VERSION_MAJOR, VERSION_MINOR
 
Method Summary
 void add(IHistogram3D h)
          Modifies this histogram by adding the contents of h to it.
 double binCentreX(int indexX)
          Centre along x, y or z of the corresponding bin.
 double binCentreY(int indexY)
           
 double binCentreZ(int indexZ)
           
 int binEntries(int indexX, int indexY, int indexZ)
          The number of entries (ie the number of times fill was called for this bin).
 int binEntriesX(int indexX)
          Equivalent to projectionXY().binEntriesX(indexX).
 int binEntriesY(int indexY)
          Equivalent to projectionXY().binEntriesY(indexY).
 int binEntriesZ(int indexZ)
          Equivalent to projectionXZ().binEntriesY(indexZ).
 double binError(int indexX, int indexY, int indexZ)
          The error on this bin.
 double binHeight(int indexX, int indexY, int indexZ)
          Total height of the corresponding bin (ie the sum of the weights in this bin).
 double binHeightX(int indexX)
          Equivalent to projectionXY().binHeightX(indexX).
 double binHeightY(int indexY)
          Equivalent to projectionXY().binHeightY(indexY).
 double binHeightZ(int indexZ)
          Equivalent to projectionXZ().binHeightY(indexZ).
 int coordToIndexX(double coordX)
          Convenience method, equivalent to xAxis().coordToIndex(coord).
 int coordToIndexY(double coordY)
          Convenience method, equivalent to yAxis().coordToIndex(coord).
 int coordToIndexZ(double coordZ)
          Convenience method, equivalent to zAxis().coordToIndex(coord).
 void fill(double x, double y, double z)
          Fill the histogram with weight 1.
 void fill(double x, double y, double z, double weight)
          Fill the histogram with specified weight.
 double meanX()
          Returns the mean of the histogram, as calculated on filling-time projected on the X axis.
 double meanY()
          Returns the mean of the histogram, as calculated on filling-time projected on the Y axis.
 double meanZ()
          Returns the mean of the histogram, as calculated on filling-time projected on the Z axis.
 double rmsX()
          Returns the rms of the histogram as calculated on filling-time projected on the X axis.
 double rmsY()
          Returns the rms of the histogram as calculated on filling-time projected on the Y axis.
 double rmsZ()
          Returns the rms of the histogram as calculated on filling-time projected on the Z axis.
 IAxis xAxis()
          Return the X axis.
 IAxis yAxis()
          Return the Y axis.
 IAxis zAxis()
          Return the Z axis.
 
Methods inherited from interface hep.aida.IHistogram
allEntries, annotation, dimension, entries, equivalentBinEntries, extraEntries, label, maxBinHeight, minBinHeight, reset, setLabel, sumAllBinHeights, sumBinHeights, sumExtraBinHeights, title
 

Method Detail

fill

public void fill(double x,
                 double y,
                 double z)
Fill the histogram with weight 1.

fill

public void fill(double x,
                 double y,
                 double z,
                 double weight)
Fill the histogram with specified weight.

binCentreX

public double binCentreX(int indexX)
Centre along x, y or z of the corresponding bin. As this may not be the simple average between upper and lower edge of the bin, it has been moved from IAxis to here.
Parameters:
index - the x (and y, z, resp.) bin number (0...Nx-1) or OVERFLOW or UNDERFLOW.

binCentreY

public double binCentreY(int indexY)

binCentreZ

public double binCentreZ(int indexZ)

binEntries

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

binEntriesX

public int binEntriesX(int indexX)
Equivalent to projectionXY().binEntriesX(indexX).

binEntriesY

public int binEntriesY(int indexY)
Equivalent to projectionXY().binEntriesY(indexY).

binEntriesZ

public int binEntriesZ(int indexZ)
Equivalent to projectionXZ().binEntriesY(indexZ).

binHeight

public double 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.

binHeightX

public double binHeightX(int indexX)
Equivalent to projectionXY().binHeightX(indexX).

binHeightY

public double binHeightY(int indexY)
Equivalent to projectionXY().binHeightY(indexY).

binHeightZ

public double binHeightZ(int indexZ)
Equivalent to projectionXZ().binHeightY(indexZ).

binError

public double 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.

meanX

public double meanX()
Returns the mean of the histogram, as calculated on filling-time projected on the X axis.

meanY

public double meanY()
Returns the mean of the histogram, as calculated on filling-time projected on the Y axis.

meanZ

public double meanZ()
Returns the mean of the histogram, as calculated on filling-time projected on the Z axis.

rmsX

public double rmsX()
Returns the rms of the histogram as calculated on filling-time projected on the X axis.

rmsY

public double rmsY()
Returns the rms of the histogram as calculated on filling-time projected on the Y axis.

rmsZ

public double rmsZ()
Returns the rms of the histogram as calculated on filling-time projected on the Z axis.

xAxis

public IAxis xAxis()
Return the X axis.

yAxis

public IAxis yAxis()
Return the Y axis.

zAxis

public IAxis zAxis()
Return the Z axis.

coordToIndexX

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

coordToIndexY

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

coordToIndexZ

public int coordToIndexZ(double coordZ)
Convenience method, equivalent to zAxis().coordToIndex(coord).
See Also:
IAxis.coordToIndex(double)

add

public void add(IHistogram3D h)
         throws IllegalArgumentException
Modifies this histogram by adding the contents of h to it.
Parameters:
h - The histogram to be added to this histogram
Throws:
IllegalArgumentException - if histogram binnings are incompatible


Copyright © 2000, 2001 AIDA Team, All Rights Reserved.