hep.aida
Interface IHistogram

All Known Subinterfaces:
IHistogram1D, IHistogram2D, IHistogram3D

public interface IHistogram
extends IConstants

User level interface to Histogram.

Version:
$Id: IHistogram.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:
IHistogram.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()
          Get the IAnnotation object.
 int dimension()
           
 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.
 String label()
          Label of the histogram
 double maxBinHeight()
          Maximum height of in-range bins in the histogram.
 double minBinHeight()
          Minimum height of in-range bins in the histogram.
 void reset()
          Reset contents; as if just constructed.
 void setLabel(String label)
           
 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.
 String title()
          Deprecated. please use label()
 

Method Detail

label

public String label()
Label of the histogram
Returns:
null if label was not set.

setLabel

public void setLabel(String label)

title

public String title()
Deprecated. please use label()

Title of the histogram (will be set only in the constructor).

annotation

public IAnnotation annotation()
Get the IAnnotation object.

dimension

public int dimension()
Returns:
1 for one-dimensional histograms, 2 for two-dimensional histograms, and so on.

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.


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