de.gsi.dataset

Interface Histogram1D

All Superinterfaces:

DataSet, DataSet3D, DataSetMetaData, EventSource, Histogram

All Known Implementing Classes:

Histogram

public interface Histogram1D
extends Histogram

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
int	fill(double x) Increment bin with abscissa X, Y, and Z by 1.
int	fill(double x, double w) Increment bin with abscissa X by with a weight w.
int	fill(String name) Increment bin with name with by 1.
int	fill(String name, double w) Increment bin with name with a weight w.
void	fillN(double[] x, double[] w, int stepSize) Fill this histogram with an array x and weights w.

Methods inherited from interface de.gsi.dataset.Histogram

addBinContent, addBinContent, findBin, findBin, findBin, getBinCenterX, getBinCenterY, getBinCenterZ, getBinContent, getDimension, getMaximum, getMinimum, getNBinsX, getNBinsY, getNBinsZ, isEquiDistant, reset

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

fill

int fill(double x)

Increment bin with abscissa X, Y, and Z by 1. if x is less than the low-edge of the first bin, the Underflow bin is incremented if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented The function returns the corresponding bin number which has its content incremented by 1

Parameters:

x - new value to be added

Returns:

corresponding bin number which has its content incremented by 1

fill

int fill(double x,
         double w)

Increment bin with abscissa X by with a weight w. if x is less than the low-edge of the first bin, the Underflow bin is incremented if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented The function returns the corresponding bin number which has its content incremented by 1

Parameters:

x - new value to be added

w - weight

Returns:

corresponding bin number which has its content incremented by 1

fill

int fill(String name)

Increment bin with name with by 1. if x is less than the low-edge of the first bin, the Underflow bin is incremented if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented

Parameters:

name - name to be added

Returns:

corresponding bin number which has its content incremented by w

fill

int fill(String name,
         double w)

Increment bin with name with a weight w. if x is less than the low-edge of the first bin, the Underflow bin is incremented if x is equal to or greater than the upper edge of last bin, the Overflow bin is incremented

Parameters:

name - name to be added

w - weight for given name

Returns:

corresponding bin number which has its content incremented by w

fillN

void fillN(double[] x,
           double[] w,
           int stepSize)

Fill this histogram with an array x and weights w.

Parameters:

x - x coordinates to be added.

w - weights to be added.

stepSize - step size through arrays x and w