AIDA API
Version 3.3

hep.aida
Interface IProfile1D

All Superinterfaces:
IBaseHistogram, IProfile

public interface IProfile1D
extends IProfile

User level interface to a 1-dimensional profile histogram

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

Method Summary
 void add(IProfile1D profile)
          Modifies this IProfile1D by adding the contents of profile to it.
 IAxis axis()
          Returns the X axis.
 int binEntries(int index)
          Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
 double binError(int index)
          The error on this bin.
 double binHeight(int index)
          Total height of the corresponding bin (ie the sum of the weights in this bin).
 double binMean(int index)
          The weighted mean of the corresponding bin.
 double binRms(int index)
          The spread (RMS) of a bin.
 int coordToIndex(double coord)
          Convenience method, equivalent to axis().coordToIndex(coord).
 void fill(double x, double y)
          Fill the IProfile1D.
 void fill(double x, double y, double weight)
          Fill the IProfile1D.
 double mean()
          Returns the mean of the in-range data of the profile as calculated on filling-time.
 double rms()
          Returns the rms of the in-range data of the profile as calculated on filling-time.
 
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

public void fill(double x,
                 double y)
          throws IllegalArgumentException
Fill the IProfile1D. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.

Throws:
IllegalArgumentException

fill

public void fill(double x,
                 double y,
                 double weight)
          throws IllegalArgumentException
Fill the IProfile1D. If either a coordinate or the weight is NaN the entry will be recorded but it will not contribue to the statistics.

Throws:
IllegalArgumentException

binMean

public double binMean(int index)
               throws IllegalArgumentException
The weighted mean of the corresponding bin.

Parameters:
index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
Returns:
The mean of the corresponding bin along the x axis.
Throws:
IllegalArgumentException - If the index is not a valid bin number.

binEntries

public int binEntries(int index)
Number of entries in the corresponding bin (ie the number of times fill was called for this bin).

Parameters:
index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

binHeight

public double binHeight(int index)
Total height of the corresponding bin (ie the sum of the weights in this bin).

Parameters:
index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

binError

public double binError(int index)
The error on this bin.

Parameters:
index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

binRms

public double binRms(int index)
The spread (RMS) of a bin.

Parameters:
index - the bin number (0...N-1) or OVERFLOW or UNDERFLOW.

mean

public double mean()
Returns the mean of the in-range data of the profile as calculated on filling-time.


rms

public double rms()
Returns the rms of the in-range data of the profile as calculated on filling-time.


axis

public IAxis axis()
Returns the X axis.


coordToIndex

public int coordToIndex(double coord)
Convenience method, equivalent to axis().coordToIndex(coord).

See Also:
IAxis.coordToIndex(double)

add

public void add(IProfile1D profile)
         throws IllegalArgumentException
Modifies this IProfile1D by adding the contents of profile to it.

Parameters:
profile - The IProfile1D to be added to this IProfile1D
Throws:
IllegalArgumentException - if profile binnings are incompatible

AIDA API
Version 3.3

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