de.gsi.dataset

Interface Histogram

All Superinterfaces:

DataSet, DataSet3D, DataSetMetaData, EventSource

All Known Subinterfaces:

Histogram1D

All Known Implementing Classes:

AbstractHistogram, Histogram, Histogram2

public interface Histogram
extends DataSet3D, DataSetMetaData

Author:

rstein

Field Summary

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Method Summary

Modifier and Type	Method and Description
void	addBinContent(int bin) Increment bin content by 1.
void	addBinContent(int bin, double w) Increment bin content by a weight w.
int	findBin(double x)
int	findBin(double x, double y)
int	findBin(double x, double y, double z)
double	getBinCenterX(int binX)
double	getBinCenterY(int binY)
double	getBinCenterZ(int binZ)
double	getBinContent(int bin) Return content of bin number bin.
int	getDimension()
double	getMaximum()
double	getMinimum()
int	getNBinsX()
int	getNBinsY()
int	getNBinsZ()
boolean	isEquiDistant()
void	reset() reset histogram content

Methods inherited from interface de.gsi.dataset.DataSet3D

getXDataCount, getYDataCount, getZ, getZRange, set

Methods inherited from interface de.gsi.dataset.DataSet

getDataCount, getDataCount, getDataLabel, getName, getStyle, getStyle, getUndefValue, getValue, getX, getXIndex, getXMax, getXMin, getXValues, getY, getYIndex, getYMax, getYMin, getYValues, isAutoNotification, lock, setAutoNotifaction, setStyle, unlock

Methods inherited from interface de.gsi.dataset.event.EventSource

addListener, invokeListener, invokeListener, removeListener, updateEventListener

Methods inherited from interface de.gsi.dataset.DataSetMetaData

getErrorList, getInfoList, getMetaInfo, getWarningList

Method Detail

isEquiDistant

boolean isEquiDistant()

Returns:

true if bin sizes are equal

reset

void reset()

reset histogram content

getBinContent

double getBinContent(int bin)

Return content of bin number bin. Convention for numbering bins For all histogram types: nbins, xlow, xup bin = 0; underflow bin bin = 1; first bin with low-edge xlow INCLUDED bin = nbins; last bin with upper-edge xup EXCLUDED bin = nbins+1; overflow bin

Parameters:

bin - the index

Returns:

numeric bin content

addBinContent

void addBinContent(int bin)

Increment bin content by 1. More...

Parameters:

bin - global bin ID

getMinimum

double getMinimum()

Returns:

minimum of histogram values

getMaximum

double getMaximum()

Returns:

maximum of histogram values

addBinContent

void addBinContent(int bin,
                   double w)

Increment bin content by a weight w. More...

Parameters:

bin - global bin ID

w - weight

findBin

int findBin(double x)

Parameters:

x - spatial real-valued coordinate in X

Returns:

bin index corresponding to spatial x and y coordinates

findBin

int findBin(double x,
            double y)

Parameters:

x - spatial real-valued coordinate in X

y - spatial real-valued coordinate in Y

Returns:

bin index corresponding to spatial x and y coordinates

findBin

int findBin(double x,
            double y,
            double z)

Parameters:

x - spatial real-valued coordinate in X

y - spatial real-valued coordinate in Y

z - spatial real-valued coordinate in Z

Returns:

bin index corresponding to spatial x, y and z coordinates

getBinCenterX

double getBinCenterX(int binX)

Parameters:

binX - index

Returns:

bin centre for X axis

getBinCenterY

double getBinCenterY(int binY)

Parameters:

binY - index

Returns:

bin centre for Y axis

getBinCenterZ

double getBinCenterZ(int binZ)

Parameters:

binZ - index

Returns:

bin centre for Y axis

getDimension

int getDimension()

Returns:

number of dimensions

getNBinsX

int getNBinsX()

Returns:

number of bin alongside X axis

getNBinsY

int getNBinsY()

Returns:

number of bin alongside Y axis

getNBinsZ

int getNBinsZ()

Returns:

number of bin alongside Z axis