de.gsi.dataset.spi

Class Histogram2

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

All Implemented Interfaces:

DataSet, DataSet3D, DataSetMetaData, EventSource, Histogram, Histogram2D

public class Histogram2
extends AbstractHistogram
implements Histogram2D

Author:

rstein

Field Summary

Fields

Modifier and Type	Field and Description
protected Histogram	xProjection
protected Histogram	yProjection

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
Histogram2(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 and 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)
List<String>	getErrorList()
List<String>	getInfoList()
Histogram1D	getProjectionX()
Histogram1D	getProjectionY()
protected double	getSumX(int bin)
protected double	getSumY(int bin)
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.
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, 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, set

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

computeLimits, getDataCount, 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, getYRange, 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.Histogram2D

findBin

Methods inherited from interface de.gsi.dataset.DataSet3D

getZRange

Methods inherited from interface de.gsi.dataset.DataSet

getDataCount, getDataCount, getName, 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

xProjection

protected final Histogram xProjection

yProjection

protected final Histogram yProjection

Constructor Detail

Histogram2

public Histogram2(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

getProjectionX

public Histogram1D getProjectionX()

Returns:

1D histogram with projection in X

getProjectionY

public Histogram1D getProjectionY()

Returns:

1D histogram with projection in Y

reset

public void reset()

Description copied from interface: Histogram

reset histogram content

Specified by:

reset in interface Histogram

Overrides:

reset in class AbstractHistogram

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

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

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 The function returns the corresponding bin number which has its content incremented by 1

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 The function returns the corresponding bin number which has its content incremented by 1

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

getInfoList

public List<String> getInfoList()

Specified by:

getInfoList in interface DataSetMetaData

Overrides:

getInfoList in class AbstractDataSet<AbstractHistogram>

getSumX

protected double getSumX(int bin)

getSumY

protected double getSumY(int bin)

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>