hep.aida
Interface IHistogram1D


public interface IHistogram1D
extends IHistogram

User level interface to 1D Histogram.

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

Fields inherited from interface hep.aida.IConstants
OVERFLOW_BIN, UNDERFLOW_BIN, VERSION, VERSION_MAJOR, VERSION_MINOR
 
Method Summary
 void add(IHistogram1D h)
          Modifies this histogram by adding the contents of h to it.
 IAxis axis()
          Returns the X axis.
 double binCentre(int index)
          Centre of the corresponding bin.
 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).
 int coordToIndex(double coord)
          Convenience method, equivalent to axis().coordToIndex(coord).
 void fill(double x)
          Fill histogram with weight 1.
 void fill(double x, double weight)
          Fill histogram with specified weight.
 double mean()
          Returns the mean of the whole histogram as calculated on filling-time.
 double rms()
          Returns the rms of the whole histogram as calculated on filling-time.
 
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)
Fill histogram with weight 1.

fill

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

binCentre

public double binCentre(int index)
Centre 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 bin number (0...N-1) or OVERFLOW or UNDERFLOW.

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.

mean

public double mean()
Returns the mean of the whole histogram as calculated on filling-time.

rms

public double rms()
Returns the rms of the whole histogram 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(IHistogram1D 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.