Interface IHistogram1D
- All Superinterfaces:
IHistogram, Serializable
- All Known Implementing Classes:
AbstractHistogram1D, Histogram1D
A Java interface corresponding to the AIDA 1D Histogram.
Note All methods that accept a bin number as an argument will also accept the constants OVERFLOW or UNDERFLOW as the argument, and as a result give the contents of the resulting OVERFLOW or UNDERFLOW bin.
- Version:
- 1.0, 23/03/2000
- See Also:
-
Field Summary
Fields inherited from interface IHistogram
OVERFLOW, serialVersionUID, UNDERFLOW -
Method Summary
Modifier and TypeMethodDescriptionintbinEntries(int index) Number of entries in the corresponding bin (ie the number of times fill was called for this bin).doublebinError(int index) The error on this bin.doublebinHeight(int index) Total height of the corresponding bin (ie the sum of the weights in this bin).voidfill(double x) Fill histogram with weight 1.voidfill(double x, double weight) Fill histogram with specified weight.doublemean()Returns the mean of the whole histogram as calculated on filling-time.int[]Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.doublerms()Returns the rms of the whole histogram as calculated on filling-time.xAxis()Returns the X Axis.Methods inherited from interface IHistogram
allEntries, dimensions, entries, equivalentBinEntries, extraEntries, reset, sumAllBinHeights, sumBinHeights, sumExtraBinHeights, title
-
Method Details
-
binEntries
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.
-
binError
double binError(int index) The error on this bin.- Parameters:
index- the bin number (0...N-1) or OVERFLOW or UNDERFLOW.
-
binHeight
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.
-
fill
void fill(double x) Fill histogram with weight 1. -
fill
void fill(double x, double weight) Fill histogram with specified weight. -
mean
double mean()Returns the mean of the whole histogram as calculated on filling-time. -
minMaxBins
int[] minMaxBins()Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.- Returns:
- {minBin,maxBin}.
-
rms
double rms()Returns the rms of the whole histogram as calculated on filling-time. -
xAxis
IAxis xAxis()Returns the X Axis.
-