hep.aida.dev
Interface IStatisticsHistogram


public interface IStatisticsHistogram
extends IConstants

A class for N-dimensional Histograms. One of the 4 fill/fillWeighted methods is called, depending on the dimension of the histogram. The split of these 4 fill/fillWeighted methods was done for performance reasons.

Version:
2.0, 06-02-2001
Author:
Pavel Binko, Dino Ferrero Merlino, Wolfgang Hoschek, Tony Johnson, Andreas Pfeiffer, Mark Donszelmann, Guy Barrand
Source Code:
IStatisticsHistogram.java

Fields inherited from interface hep.aida.IConstants
OVERFLOW_BIN, UNDERFLOW_BIN, VERSION, VERSION_MAJOR, VERSION_MINOR
 
Method Summary
 int allEntries()
          Number of all entries in all (both in-range and under/overflow) bins in the histogram.
 IAnnotation annotation()
          to be defined
 IAxis axis(int axis)
          Returns the 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).
 int dimension()
          Returns the dimension of the histogram.
 int entries()
          Number of in-range entries in the histogram.
 double equivalentBinEntries()
          Number of equivalent entries.
 int extraEntries()
          Number of under and overflow entries in the histogram.
 void fill(double x)
          Fill histogram with weight 1.
 void fill(double[] x)
          Fill histogram with weight 1.
 void fill(double x, double y)
          Fill histogram with weight 1.
 void fill(double x, double y, double z)
          Fill histogram with weight 1.
 void fillWeighted(double[] x, double weight)
          Fill histogram with specified weight.
 void fillWeighted(double x, double weight)
          Fill histogram with specified weight.
 void fillWeighted(double x, double y, double weight)
          Fill histogram with specified weight.
 void fillWeighted(double x, double y, double z, double weight)
          Fill histogram with specified weight.
 String label()
          Label of the histogram (will be set only in the constructor).
 double maxBinHeight()
          Maximum height of in-range bins in the histogram.
 double mean(int axis)
          Returns the mean of the whole histogram as calculated on filling-time.
 double minBinHeight()
          Minimum height of in-range bins in the histogram.
 void reset()
          Reset contents; as if just constructed.
 double rms(int axis)
          Returns the rms of the whole histogram as calculated on filling-time.
 double sumAllBinHeights()
          Sum of all (both in-range and under/overflow) bin heights in the histogram.
 double sumBinHeights()
          Sum of in-range bin heights in the histogram.
 double sumExtraBinHeights()
          Sum of under/overflow bin heights in the histogram.
 

Method Detail

fill

public void fill(double x)
Fill histogram with weight 1. This method is called for 1D histograms.

fillWeighted

public void fillWeighted(double x,
                         double weight)
Fill histogram with specified weight. This method is called for 1D histograms.

fill

public void fill(double x,
                 double y)
Fill histogram with weight 1. This method is called for 2D histograms.

fillWeighted

public void fillWeighted(double x,
                         double y,
                         double weight)
Fill histogram with specified weight. This method is called for 2D histograms.

fill

public void fill(double x,
                 double y,
                 double z)
Fill histogram with weight 1. This method is called for 3D histograms.

fillWeighted

public void fillWeighted(double x,
                         double y,
                         double z,
                         double weight)
Fill histogram with specified weight. This method is called for 3D histograms.

fill

public void fill(double[] x)
Fill histogram with weight 1. This method is called for > 3D histograms.

fillWeighted

public void fillWeighted(double[] x,
                         double weight)
Fill histogram with specified weight. This method is called for > 3D histograms.

label

public String label()
Label of the histogram (will be set only in the constructor).

annotation

public IAnnotation annotation()
to be defined

dimension

public int dimension()
Returns the dimension of the histogram.

reset

public void reset()
Reset contents; as if just constructed.

entries

public int entries()
Number of in-range entries in the histogram.

allEntries

public int allEntries()
Number of all entries in all (both in-range and under/overflow) bins in the histogram.

extraEntries

public int extraEntries()
Number of under and overflow entries in the histogram.

equivalentBinEntries

public double equivalentBinEntries()
Number of equivalent entries.
Returns:
SUM[ weight ] ^ 2 / SUM[ weight^2 ].

sumBinHeights

public double sumBinHeights()
Sum of in-range bin heights in the histogram.

sumAllBinHeights

public double sumAllBinHeights()
Sum of all (both in-range and under/overflow) bin heights in the histogram.

sumExtraBinHeights

public double sumExtraBinHeights()
Sum of under/overflow bin heights in the histogram.

minBinHeight

public double minBinHeight()
Minimum height of in-range bins in the histogram.

maxBinHeight

public double maxBinHeight()
Maximum height of in-range bins in the histogram.

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(int axis)
Returns the mean of the whole histogram as calculated on filling-time.

rms

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

axis

public IAxis axis(int axis)
Returns the axis.


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