hep.aida.tfloat

Interface FloatIHistogram1D

All Superinterfaces:

FloatIHistogram, java.io.Serializable

All Known Implementing Classes:

FloatHistogram1D

public interface FloatIHistogram1D
extends FloatIHistogram

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.

See Also:

AIDA

Field Summary

Fields inherited from interface hep.aida.tfloat.FloatIHistogram

OVERFLOW, serialVersionUID, UNDERFLOW

Method Summary

Modifier and Type	Method and Description
int	binEntries(int index) Number of entries in the corresponding bin (ie the number of times fill was called for this bin).
float	binError(int index) The error on this bin.
float	binHeight(int index) Total height of the corresponding bin (ie the sum of the weights in this bin).
void	fill_2D(float[] data, float[] weights, int rows, int columns, int zero, int rowStride, int columnStride) Fill histogram with specified data and weights.
void	fill_2D(float[] data, int rows, int columns, int zero, int rowStride, int columnStride) Fill histogram with specified data and weight 1.
void	fill(float x) Fill histogram with weight 1.
void	fill(float x, float weight) Fill histogram with specified weight.
float	mean() Returns the mean of the whole histogram as calculated on filling-time.
int[]	minMaxBins() Indexes of the in-range bins containing the smallest and largest binHeight(), respectively.
float	rms() Returns the rms of the whole histogram as calculated on filling-time.
FloatIAxis	xAxis() Returns the X Axis.

Methods inherited from interface hep.aida.tfloat.FloatIHistogram

allEntries, dimensions, entries, equivalentBinEntries, extraEntries, reset, sumAllBinHeights, sumBinHeights, sumExtraBinHeights, title

Method Detail

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

float binError(int index)

The error on this bin.

Parameters:

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

binHeight

float 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(float x)

Fill histogram with weight 1.

fill

void fill(float x,
          float weight)

Fill histogram with specified weight.

fill_2D

void fill_2D(float[] data,
             int rows,
             int columns,
             int zero,
             int rowStride,
             int columnStride)

Fill histogram with specified data and weight 1.

fill_2D

void fill_2D(float[] data,
             float[] weights,
             int rows,
             int columns,
             int zero,
             int rowStride,
             int columnStride)

Fill histogram with specified data and weights.

mean

float 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

float rms()

Returns the rms of the whole histogram as calculated on filling-time.

xAxis

FloatIAxis xAxis()

Returns the X Axis.