hep.aida

Interface IProfile2D

All Superinterfaces:

IBaseHistogram, IProfile

All Known Implementing Classes:

Profile2D

public interface IProfile2D
extends IProfile

User level interface to a 2-dimensional profile histogram

Method Summary

Modifier and Type	Method and Description
void	add(IProfile2D h) Modifies this profile by adding the contents of profile to it.
int	binEntries(int indexX, int indexY) The number of entries (ie the number of times fill was called for this bin).
int	binEntriesX(int indexX) Equivalent to projectionX().binEntries(indexX).
int	binEntriesY(int indexY) Equivalent to projectionY().binEntries(indexY).
double	binError(int indexX, int indexY) The error on this bin.
double	binHeight(int indexX, int indexY) Total height of the corresponding bin (ie the sum of the weights in this bin).
double	binHeightX(int indexX) Equivalent to projectionX().binHeight(indexX).
double	binHeightY(int indexY) Equivalent to projectionY().binHeight(indexY).
double	binMeanX(int indexX, int indexY) The weighted mean along x of a given bin.
double	binMeanY(int indexX, int indexY) The weighted mean along y of a given bin.
double	binRms(int indexX, int indexY) The spread (RMS) of this bin.
int	coordToIndexX(double coordX) Convenience method, equivalent to xAxis().coordToIndex(coord).
int	coordToIndexY(double coordY) Convenience method, equivalent to yAxis().coordToIndex(coord).
void	fill(double x, double y, double z) Fill the IProfile2D.
void	fill(double x, double y, double z, double weight) Fill the IProfile2D.
double	meanX() Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the X axis.
double	meanY() Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the Y axis.
double	rmsX() Returns the rms of the in-range data of the profile as calculated on filling-time projected on the X axis.
double	rmsY() Returns the rms of the in-range data of the profile as calculated on filling-time projected on the Y axis.
IAxis	xAxis() Return the X axis.
IAxis	yAxis() Return the Y axis.

Methods inherited from interface hep.aida.IProfile

allEntries, extraEntries, maxBinHeight, minBinHeight, sumAllBinHeights, sumBinHeights, sumExtraBinHeights

Methods inherited from interface hep.aida.IBaseHistogram

annotation, dimension, entries, nanEntries, reset, setTitle, title

Method Detail

fill

void fill(double x,
          double y,
          double z)
   throws java.lang.IllegalArgumentException

Fill the IProfile2D. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.

Throws:

java.lang.IllegalArgumentException

fill

void fill(double x,
          double y,
          double z,
          double weight)
   throws java.lang.IllegalArgumentException

Fill the IProfile2D. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.

Throws:

java.lang.IllegalArgumentException

binMeanX

double binMeanX(int indexX,
                int indexY)
         throws java.lang.IllegalArgumentException

The weighted mean along x 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.

Returns:

The mean of the corresponding bin along the x axis.

Throws:

java.lang.IllegalArgumentException - If the indexes are not a valid bin number.

binMeanY

double binMeanY(int indexX,
                int indexY)
         throws java.lang.IllegalArgumentException

The weighted mean along y 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.

Returns:

The mean of the corresponding bin along the x axis.

Throws:

java.lang.IllegalArgumentException - If the indexes are not a valid bin number.

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

binHeight

double 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

double binHeightX(int indexX)

Equivalent to projectionX().binHeight(indexX).

binHeightY

double binHeightY(int indexY)

Equivalent to projectionY().binHeight(indexY).

binError

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

binRms

double binRms(int indexX,
              int indexY)

The spread (RMS) of 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.

meanX

double meanX()

Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the X axis.

meanY

double meanY()

Returns the mean of the in-range data of the profile, as calculated on filling-time projected on the Y axis.

rmsX

double rmsX()

Returns the rms of the in-range data of the profile as calculated on filling-time projected on the X axis.

rmsY

double rmsY()

Returns the rms of the in-range data of the profile as calculated on filling-time projected on the Y axis.

xAxis

IAxis xAxis()

Return the X axis.

yAxis

IAxis yAxis()

Return the Y axis.

coordToIndexX

int coordToIndexX(double coordX)

Convenience method, equivalent to xAxis().coordToIndex(coord).

See Also:

IAxis.coordToIndex(double)

coordToIndexY

int coordToIndexY(double coordY)

Convenience method, equivalent to yAxis().coordToIndex(coord).

See Also:

IAxis.coordToIndex(double)

add

void add(IProfile2D h)
  throws java.lang.IllegalArgumentException

Modifies this profile by adding the contents of profile to it.

Parameters:

profile - The IProfile2D to be added to this IProfile2D

Throws:

java.lang.IllegalArgumentException - if the profile binnings are incompatible