de.gsi.dataset.spi

Class Histogram

java.lang.Object

de.gsi.dataset.spi.AbstractStylable<D>

de.gsi.dataset.spi.AbstractDataSet<D>

de.gsi.dataset.spi.AbstractDataSet3D<AbstractHistogram>

de.gsi.dataset.spi.AbstractHistogram

de.gsi.dataset.spi.Histogram

All Implemented Interfaces:

DataSet, DataSet3D, DataSetMetaData, EventSource, Histogram, Histogram1D

public class Histogram
extends AbstractHistogram
implements Histogram1D

Class implements simple one dimensional binned histogram backed internally by double arrays

Author:

rstein

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isHorizontal

Fields inherited from class de.gsi.dataset.spi.AbstractHistogram

dataLabels, dataStyles

Fields inherited from class de.gsi.dataset.spi.AbstractDataSet3D

zRange

Fields inherited from class de.gsi.dataset.spi.AbstractDataSet

lock, name, updateListeners, xRange, yRange

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor and Description
Histogram(String name, double[] xBins) Creates histogram with name and range [minX, maxX]
Histogram(String name, double[] xBins, boolean horizontal) Creates histogram with name and range [minX, maxX]
Histogram(String name, int nBins, double minX, double maxX) Creates histogram with name and range [minX, maxX]
Histogram(String name, int nBins, double minX, double maxX, boolean horizontal) Creates histogram with name and range [minX, maxX]

Method Summary

Modifier and Type	Method and Description
protected Histogram	computeLimits() recompute data set limits
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.
int	getDataCount() Get the number of data points in the data set
List<String>	getErrorList()
List<String>	getInfoList()
List<String>	getWarningList()
double	getX(int i) Gets the x value of the data point with the index i
int	getXDataCount() Returns number of X coordinates.
double	getY(int i) Gets the y value of the data point with the index i
int	getYDataCount() Returns number of Y coordinates.
DataRange	getYRange()
double	getZ(int xIndex, int yIndex) Returns Z coordinate for the specified data point.

Methods inherited from class de.gsi.dataset.spi.AbstractHistogram

addBinContent, addBinContent, addDataLabel, addDataStyle, findBin, findBin, findBin, findBinX, findBinY, findBinZ, findNextLargerIndex, getBinCenterX, getBinCenterY, getBinCenterZ, getBinContent, getDataLabel, getDataLabelMap, getDataStyleMap, getDimension, getMaximum, getMinimum, getNBinsX, getNBinsY, getNBinsZ, getStyle, getValueRange, isEquiDistant, removeDataLabel, removeStyle, reset, set

Methods inherited from class de.gsi.dataset.spi.AbstractDataSet3D

getXIndex, getYIndex, getZRange

Methods inherited from class de.gsi.dataset.spi.AbstractDataSet

binarySearchX, binarySearchY, fireInvalidated, getDataCount, getMetaInfo, getName, getThis, getUndefValue, getXMax, getXMin, getXRange, getYMax, getYMin, isAutoNotification, lock, minNeigbourSearchX, setAutoNotifaction, setName, toString, unlock, updateEventListener

Methods inherited from class de.gsi.dataset.spi.AbstractStylable

getStyle, setStyle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getZRange, set

Methods inherited from interface de.gsi.dataset.DataSet

getDataCount, getDataLabel, getName, getStyle, getStyle, getUndefValue, getValue, getXIndex, getXMax, getXMin, getXValues, 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

getMetaInfo

Field Detail

isHorizontal

protected final boolean isHorizontal

Constructor Detail

Histogram

public Histogram(String name,
                 int nBins,
                 double minX,
                 double maxX,
                 boolean horizontal)

Creates histogram with name and range [minX, maxX]

Parameters:

name - of the data sets

nBins - number of bins

minX - minimum of range

maxX - maximum of range

horizontal - whether binning is performed in X

Histogram

public Histogram(String name,
                 int nBins,
                 double minX,
                 double maxX)

Creates histogram with name and range [minX, maxX]

Parameters:

name - of the data sets

nBins - number of bins

minX - minimum of range

maxX - maximum of range

Histogram

public Histogram(String name,
                 double[] xBins,
                 boolean horizontal)

Creates histogram with name and range [minX, maxX]

Parameters:

name - of the data sets

xBins - the initial bin array (defines [minX, maxX] and nBins)

horizontal - whether binning is performed in X

Histogram

public Histogram(String name,
                 double[] xBins)

Creates histogram with name and range [minX, maxX]

Parameters:

name - of the data sets

xBins - the initial bin array (defines [minX, maxX] and nBins)

Method Detail

getDataCount

public int getDataCount()

Get the number of data points in the data set

Specified by:

getDataCount in interface DataSet

Overrides:

getDataCount in class AbstractDataSet3D<AbstractHistogram>

Returns:

the number of data points

getXDataCount

public int getXDataCount()

Description copied from interface: DataSet3D

Returns number of X coordinates.

Specified by:

getXDataCount in interface DataSet3D

Returns:

the number of y axis bins

getYDataCount

public int getYDataCount()

Description copied from interface: DataSet3D

Returns number of Y coordinates.

Specified by:

getYDataCount in interface DataSet3D

Returns:

the number of y axis bins

getX

public double getX(int i)

Description copied from interface: DataSet

Gets the x value of the data point with the index i

Specified by:

getX in interface DataSet

Parameters:

i - the index of the data point

Returns:

the x value

getY

public double getY(int i)

Description copied from interface: DataSet

Gets the y value of the data point with the index i

Specified by:

getY in interface DataSet

Parameters:

i - the index of the data point

Returns:

the y value

getYRange

public DataRange getYRange()

Overrides:

getYRange in class AbstractDataSet<AbstractHistogram>

Returns:

vertical range of data set

fill

public int fill(double x)

Description copied from interface: Histogram1D

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

Specified by:

fill in interface Histogram1D

Parameters:

x - new value to be added

Returns:

corresponding bin number which has its content incremented by 1

fill

public int fill(double x,
                double w)

Description copied from interface: Histogram1D

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

Specified by:

fill in interface Histogram1D

Parameters:

x - new value to be added

w - weight

Returns:

corresponding bin number which has its content incremented by 1

fill

public int fill(String name)

Description copied from interface: Histogram1D

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

Specified by:

fill in interface Histogram1D

Parameters:

name - name to be added

Returns:

corresponding bin number which has its content incremented by w

fill

public int fill(String name,
                double w)

Description copied from interface: Histogram1D

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

Specified by:

fill in interface Histogram1D

Parameters:

name - name to be added

w - weight for given name

Returns:

corresponding bin number which has its content incremented by w

fillN

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

Description copied from interface: Histogram1D

Fill this histogram with an array x and weights w.

Specified by:

fillN in interface Histogram1D

Parameters:

x - x coordinates to be added.

w - weights to be added.

stepSize - step size through arrays x and w

getZ

public double getZ(int xIndex,
                   int yIndex)

Description copied from interface: DataSet3D

Returns Z coordinate for the specified data point.

Specified by:

getZ in interface DataSet3D

Parameters:

xIndex - index of X coordinate

yIndex - index of Y coordinate

Returns:

Z coordinate

getInfoList

public List<String> getInfoList()

Specified by:

getInfoList in interface DataSetMetaData

Overrides:

getInfoList in class AbstractDataSet<AbstractHistogram>

computeLimits

protected Histogram computeLimits()

Description copied from class: AbstractDataSet3D

recompute data set limits

Overrides:

computeLimits in class AbstractDataSet3D<AbstractHistogram>

Returns:

itself (fluent design)

getWarningList

public List<String> getWarningList()

Specified by:

getWarningList in interface DataSetMetaData

Overrides:

getWarningList in class AbstractDataSet<AbstractHistogram>

getErrorList

public List<String> getErrorList()

Specified by:

getErrorList in interface DataSetMetaData

Overrides:

getErrorList in class AbstractDataSet<AbstractHistogram>