Package de.gsi.dataset.spi

Class Histogram2

java.lang.Object

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

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

de.gsi.dataset.spi.AbstractHistogram

de.gsi.dataset.spi.Histogram2

All Implemented Interfaces:

DataSet, DataSetMetaData, EventSource, Histogram, Histogram2D, java.io.Serializable

public class Histogram2
extends AbstractHistogram
implements Histogram2D

Author:

rstein

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Histogram	xProjection
protected Histogram	yProjection

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

axisBins, data, nAxisBins

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
Histogram2(java.lang.String name, int nBinsX, double minX, double maxX, int nBinsY, double minY, double maxY)	Creates 2D histogram with name and ranges [minX, maxX] and [minY, maxY]

Method Summary

Modifier and Type	Method	Description
int	fill(double x, double y)	Increment bin with abscissa X, Y, and Z by 1.
int	fill(double x, double y, double w)	Increment bin with abscissa X by with a weight w.
int	findFirstBinAbove(double x, double y)
double	get(int dimIndex, int binIndex)	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 x coordinate.
java.util.List<java.lang.String>	getInfoList()
Histogram1D	getProjectionX()
Histogram1D	getProjectionY()
protected double	getSum(int dimIndex, int bin)
double	getValue(int dimIndex, double x)	Gets the interpolated y value of the data point for given x coordinate
java.util.List<java.lang.String>	getWarningList()
double	getZ(int xIndex, int yIndex)	Returns Z coordinate for the specified data point.
void	reset()	reset histogram content

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

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

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

addDataLabel, addDataStyle, autoNotification, binarySearch, clearMetaInfo, equalDataLabels, equalEditConstraints, equalErrorValues, equalMetaData, equals, equals, equalValues, fireInvalidated, getAxisDescriptions, getDataLabel, getDataLabelMap, getDataStyleMap, getDimension, getEditConstraints, getMetaInfo, getName, getStyle, getThis, hashCode, lock, minNeigbourSearchX, 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, getDataLabel, getDimension, getName, getStyle, getStyle, getValues, lock, recomputeLimits, setStyle

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.Histogram2D

findBin

Field Detail

xProjection

protected final Histogram xProjection

yProjection

protected final Histogram yProjection

Constructor Detail

Histogram2

public Histogram2(java.lang.String name,
                  int nBinsX,
                  double minX,
                  double maxX,
                  int nBinsY,
                  double minY,
                  double maxY)

Creates 2D histogram with name and ranges [minX, maxX] and [minY, maxY]

Parameters:

name - of the data sets

nBinsX - number of horizontal bins

minX - minimum of horizontal range

maxX - maximum of horizontal range

nBinsY - number of vertical bins

minY - minimum of vertical range

maxY - maximum of vertical range

Method Detail

fill

public int fill(double x,
                double y)

Description copied from interface: Histogram2D

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

Specified by:

fill in interface Histogram2D

Parameters:

x - new value to be added

y - new value to be added

Returns:

corresponding bin number which has its content incremented by 1

fill

public int fill(double x,
                double y,
                double w)

Description copied from interface: Histogram2D

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

Specified by:

fill in interface Histogram2D

Parameters:

x - new value to be added

y - new value to be added

w - weight

Returns:

corresponding bin number which has its content incremented by 1

findFirstBinAbove

public int findFirstBinAbove(double x,
                             double y)

Specified by:

findFirstBinAbove in interface Histogram2D

Parameters:

x - spatial real-valued coordinate in X

y - spatial real-valued coordinate in Y

Returns:

bin index that is above the spatial x and y coordinates

get

public double get(int dimIndex,
                  int binIndex)

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')

binIndex - 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 class: AbstractDataSet

Gets the index of the data point closest to the given x coordinate. If the x coordinate lies outside the range of the data set, the index of the first/last point is returned.

Specified by:

getIndex in interface DataSet

Overrides:

getIndex in class AbstractDataSet<AbstractHistogram>

Parameters:

dimIndex - the dimension index

value - the x position of the data point

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>

getProjectionX

public Histogram1D getProjectionX()

Returns:

1D histogram with projection in X

getProjectionY

public Histogram1D getProjectionY()

Returns:

1D histogram with projection in Y

getSum

protected double getSum(int dimIndex,
                        int bin)

getValue

public double getValue(int dimIndex,
                       double x)

Description copied from interface: DataSet

Gets the interpolated y value of the data point for given x coordinate

Specified by:

getValue in interface DataSet

Parameters:

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

x - the new x coordinate

Returns:

the y value

getWarningList

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

Specified by:

getWarningList in interface DataSetMetaData

Overrides:

getWarningList in class AbstractDataSet<AbstractHistogram>

getZ

public double getZ(int xIndex,
                   int yIndex)

Description copied from interface: Histogram2D

Returns Z coordinate for the specified data point.

Specified by:

getZ in interface Histogram2D

Parameters:

xIndex - index of X coordinate

yIndex - index of Y coordinate

Returns:

Z coordinate

reset

public void reset()

Description copied from interface: Histogram

reset histogram content

Specified by:

reset in interface Histogram

Overrides:

reset in class AbstractHistogram