Package de.gsi.dataset.spi

Class Histogram

java.lang.Object

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

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

de.gsi.dataset.spi.AbstractHistogram

de.gsi.dataset.spi.Histogram

All Implemented Interfaces:

DataSet, DataSet2D, DataSetMetaData, EventSource, Histogram, Histogram1D, java.io.Serializable

public class Histogram
extends AbstractHistogram
implements Histogram1D, DataSet2D

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

Author:

rstein

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.gsi.dataset.spi.AbstractHistogram

AbstractHistogram.HistogramOuterBounds

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isHorizontal

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

axisBins, data, nAxisBins

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

axisListener, dimension

Fields inherited from interface de.gsi.dataset.DataSet

DIM_X, DIM_Y, DIM_Z

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor	Description
Histogram(java.lang.String name, double[] xBins)	Creates histogram with name and range [minX, maxX]
Histogram(java.lang.String name, double[] xBins, boolean horizontal)	Creates histogram with name and range [minX, maxX]
Histogram(java.lang.String name, int nBins, double minX, double maxX, boolean horizontal, AbstractHistogram.HistogramOuterBounds boundsType)	Creates histogram with name and range [minX, maxX]
Histogram(java.lang.String name, int nBins, double minX, double maxX, AbstractHistogram.HistogramOuterBounds boundsType)	Creates histogram with name and range [minX, maxX]

Method Summary

Modifier and Type	Method	Description
void	addBinContent(int bin, double w)	Increment bin content by a weight w.
int	fill(double x, double w)	Increment bin with abscissa X by with a weight w.
void	fillN(double[] x, double[] w, int stepSize)	Fill this histogram with an array x and weights w.
int	findBin(int dimIndex, double x)
double	get(int dimIndex, int index)	Gets the x value of the data point with the index i
java.util.List<java.lang.String>	getErrorList()
int	getIndex(int dimIndex, double... value)	Gets the index of the data point closest to the given 'value' coordinate.
java.util.List<java.lang.String>	getInfoList()
double	getValue(int dimIndex, double x)
java.util.List<java.lang.String>	getWarningList()
void	reset()	reset histogram content
DataSet	set(DataSet other, boolean copy)

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

addBinContent, findBin, findBin, findNextLargerIndex, getBinCenter, getBinContent, getDataCount, isEquiDistant

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

addDataLabel, addDataStyle, autoNotification, binarySearch, binarySearch, clearMetaInfo, copyAxisDescription, copyDataLabelsAndStyles, copyMetaData, equalDataLabels, equalEditConstraints, equalErrorValues, equalMetaData, equals, equals, equalValues, fireInvalidated, getAxisDescriptions, getDataLabel, getDataLabelMap, getDataStyleMap, getDimension, getEditConstraints, getMetaInfo, getName, getStyle, getThis, getValue, getValues, hashCode, lock, recomputeLimits, removeDataLabel, removeStyle, setEditConstraints, setName, toString, updateEventListener

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

getStyle, setStyle

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.gsi.dataset.DataSet

getAxisDescription, getAxisDescriptions, getDataCount, getDataLabel, getName, getStyle, getStyle, getValue, getValues, lock, recomputeLimits, set, setStyle

Methods inherited from interface de.gsi.dataset.DataSet2D

getDimension, getValue, getX, getXIndex, getXValues, getY, getYIndex, getYValues

Methods inherited from interface de.gsi.dataset.DataSetMetaData

getMetaInfo

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

addListener, autoNotification, invokeListener, invokeListener, invokeListener, isAutoNotification, removeListener, updateEventListener

Methods inherited from interface de.gsi.dataset.Histogram

addBinContent, findBin, findBin, getBinCenter, getBinContent, isEquiDistant

Methods inherited from interface de.gsi.dataset.Histogram1D

fill

Field Detail

isHorizontal

protected final boolean isHorizontal

Constructor Detail

Histogram

public Histogram(java.lang.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)

Histogram

public Histogram(java.lang.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(java.lang.String name,
                 int nBins,
                 double minX,
                 double maxX,
                 AbstractHistogram.HistogramOuterBounds boundsType)

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

boundsType - How the min and max value should be interpreted

Histogram

public Histogram(java.lang.String name,
                 int nBins,
                 double minX,
                 double maxX,
                 boolean horizontal,
                 AbstractHistogram.HistogramOuterBounds boundsType)

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

boundsType - How the min and max value should be interpreted

Method Detail

addBinContent

public void addBinContent(int bin,
                          double w)

Description copied from interface: Histogram

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

Specified by:

addBinContent in interface Histogram

Overrides:

addBinContent in class AbstractHistogram

Parameters:

bin - global bin ID

w - weight

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

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

findBin

public int findBin(int dimIndex,
                   double x)

Specified by:

findBin in interface Histogram

Overrides:

findBin in class AbstractHistogram

Parameters:

dimIndex - the dimension index

x - spatial real-valued coordinate for dimension dimIndex

Returns:

bin index corresponding to spatial x and y coordinates

get

public double get(int dimIndex,
                  int index)

Description copied from interface: DataSet

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

Specified by:

get in interface DataSet

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

index - data point index

Returns:

the x value

getErrorList

public java.util.List<java.lang.String> getErrorList()

Specified by:

getErrorList in interface DataSetMetaData

Overrides:

getErrorList in class AbstractDataSet<AbstractHistogram>

getIndex

public int getIndex(int dimIndex,
                    double... value)

Description copied from interface: DataSet

Gets the index of the data point closest to the given 'value' coordinate. The index returned may be less then zero or larger the the number of data points in the data set, if the x coordinate lies outside the range of the data set.

Specified by:

getIndex in interface DataSet

Overrides:

getIndex in class AbstractDataSet<AbstractHistogram>

Parameters:

dimIndex - the dimension index (ie. '0' equals 'X', '1' equals 'Y')

value - the data point coordinates to search for

Returns:

the index of the data point

getInfoList

public java.util.List<java.lang.String> getInfoList()

Specified by:

getInfoList in interface DataSetMetaData

Overrides:

getInfoList in class AbstractDataSet<AbstractHistogram>

getValue

public double getValue(int dimIndex,
                       double x)

getWarningList

public java.util.List<java.lang.String> getWarningList()

Specified by:

getWarningList in interface DataSetMetaData

Overrides:

getWarningList in class AbstractDataSet<AbstractHistogram>

reset

public void reset()

Description copied from interface: Histogram

reset histogram content

Specified by:

reset in interface Histogram

Overrides:

reset in class AbstractHistogram

set

public DataSet set(DataSet other,
                   boolean copy)

Specified by:

set in interface DataSet

Parameters:

other - Other DataSet to copy into this DataSet

copy - true: perform a deep copy (default), false: reuse the other dataset's internal data structures (if applicable)

Returns:

itself (fluent design) -- N.B. existing update listener are preserved