de.gsi.dataset.spi

Class AbstractHistogram

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

All Implemented Interfaces:

DataSet, DataSet3D, DataSetMetaData, EventSource, Histogram

Direct Known Subclasses:

Histogram, Histogram2

public abstract class AbstractHistogram
extends AbstractDataSet3D<AbstractHistogram>
implements Histogram

Author:

rstein

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,String>	dataLabels
protected Map<Integer,String>	dataStyles

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

zRange

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

editConstraints, errorList, infoList, lock, metaInfoMap, name, updateListeners, warningList, xRange, yRange

Fields inherited from interface de.gsi.dataset.DataSetMetaData

TAG_GAIN_RANGE, TAG_OVERSHOOT, TAG_UNDERSHOOT

Constructor Summary

Constructors

Constructor and Description
AbstractHistogram(String name, double[] xBins) Creates histogram with name and range [minX, maxX]
AbstractHistogram(String name, int nBins, double minX, double maxX) Creates histogram with name and range [minX, maxX]
AbstractHistogram(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
void	addBinContent(int bin) Increment bin content by 1.
void	addBinContent(int bin, double w) Increment bin content by a weight w.
String	addDataLabel(int index, String label) adds a custom new data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.
String	addDataStyle(int index, String style) A string representation of the CSS style associated with this specific DataSet data point.
int	findBin(double x)
int	findBin(double x, double y)
int	findBin(double x, double y, double z)
protected int	findBinX(double x)
protected int	findBinY(double y)
protected int	findBinZ(double z)
protected int	findNextLargerIndex(double[] bin, double value)
double	getBinCenterX(int binX)
double	getBinCenterY(int binY)
double	getBinCenterZ(int binZ)
double	getBinContent(int bin) Return content of bin number bin.
String	getDataLabel(int index) Returns label of a data point specified by the index.
int	getDimension()
double	getMaximum()
double	getMinimum()
int	getNBinsX()
int	getNBinsY()
int	getNBinsZ()
String	getStyle(int bin) A string representation of the CSS style associated with this specific DataSet data point.
DataRange	getValueRange()
boolean	isEquiDistant()
String	removeDataLabel(int index) remove a custom data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.
String	removeStyle(int index) A string representation of the CSS style associated with this specific DataSet data point.
void	reset() reset histogram content
void	set(int xIndex, int yIndex, double x, double y, double z) Changes a data point at specified index to new values.

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, clearMetaInfo, fireInvalidated, getDataCount, getDataLabelMap, getDataStyleMap, getEditConstraints, getErrorList, getInfoList, getMetaInfo, getName, getThis, getUndefValue, getWarningList, getXMax, getXMin, getXRange, getYMax, getYMin, getYRange, isAutoNotification, lock, minNeigbourSearchX, setAutoNotifaction, setEditConstraints, 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.DataSet3D

getXDataCount, getYDataCount, getZ, getZRange

Methods inherited from interface de.gsi.dataset.DataSet

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

Field Detail

dataLabels

protected Map<Integer,String> dataLabels

dataStyles

protected Map<Integer,String> dataStyles

Constructor Detail

AbstractHistogram

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

AbstractHistogram

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

AbstractHistogram

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

isEquiDistant

public boolean isEquiDistant()

Specified by:

isEquiDistant in interface Histogram

Returns:

true if bin sizes are equal

getValueRange

public DataRange getValueRange()

Returns:

range of bin contents

addDataStyle

public String addDataStyle(int index,
                           String style)

A string representation of the CSS style associated with this specific DataSet data point. @see #getStyle()

Overrides:

addDataStyle in class AbstractDataSet<AbstractHistogram>

Parameters:

index - the index of the specific data point

style - the CSS style for the given data bin

Returns:

itself (fluent interface)

removeStyle

public String removeStyle(int index)

A string representation of the CSS style associated with this specific DataSet data point. @see #getStyle()

Overrides:

removeStyle in class AbstractDataSet<AbstractHistogram>

Parameters:

index - the index of the specific data point

Returns:

itself (fluent interface)

getStyle

public String getStyle(int bin)

A string representation of the CSS style associated with this specific DataSet data point. @see #getStyle()

Specified by:

getStyle in interface DataSet

Overrides:

getStyle in class AbstractDataSet<AbstractHistogram>

Parameters:

bin - the index of the specific data point

Returns:

user-specific data set style description (ie. may be set by user)

addDataLabel

public String addDataLabel(int index,
                           String label)

adds a custom new data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Overrides:

addDataLabel in class AbstractDataSet<AbstractHistogram>

Parameters:

index - of the data point

label - for the data point specified by the index

Returns:

the previously set label or null if no label has been specified

removeDataLabel

public String removeDataLabel(int index)

remove a custom data label for a point The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Overrides:

removeDataLabel in class AbstractDataSet<AbstractHistogram>

Parameters:

index - of the data point

Returns:

the previously set label or null if no label has been specified

getDataLabel

public String getDataLabel(int index)

Returns label of a data point specified by the index. The label can be used as a category name if CategoryStepsDefinition is used or for annotations displayed for data points.

Specified by:

getDataLabel in interface DataSet

Overrides:

getDataLabel in class AbstractDataSet<AbstractHistogram>

Parameters:

index - of the data label

Returns:

data point label specified by the index or null if no label has been specified

getBinContent

public double getBinContent(int bin)

Description copied from interface: Histogram

Return content of bin number bin. Convention for numbering bins For all histogram types: nbins, xlow, xup bin = 0; underflow bin bin = 1; first bin with low-edge xlow INCLUDED bin = nbins; last bin with upper-edge xup EXCLUDED bin = nbins+1; overflow bin

Specified by:

getBinContent in interface Histogram

Parameters:

bin - the index

Returns:

numeric bin content

addBinContent

public void addBinContent(int bin)

Description copied from interface: Histogram

Increment bin content by 1. More...

Specified by:

addBinContent in interface Histogram

Parameters:

bin - global bin ID

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

Parameters:

bin - global bin ID

w - weight

getMinimum

public double getMinimum()

Specified by:

getMinimum in interface Histogram

Returns:

minimum of histogram values

getMaximum

public double getMaximum()

Specified by:

getMaximum in interface Histogram

Returns:

maximum of histogram values

findNextLargerIndex

protected int findNextLargerIndex(double[] bin,
                                  double value)

findBin

public int findBin(double x)

Specified by:

findBin in interface Histogram

Parameters:

x - spatial real-valued coordinate in X

Returns:

bin index corresponding to spatial x and y coordinates

findBinX

protected int findBinX(double x)

findBinY

protected int findBinY(double y)

findBinZ

protected int findBinZ(double z)

findBin

public int findBin(double x,
                   double y)

Specified by:

findBin in interface Histogram

Parameters:

x - spatial real-valued coordinate in X

y - spatial real-valued coordinate in Y

Returns:

bin index corresponding to spatial x and y coordinates

findBin

public int findBin(double x,
                   double y,
                   double z)

Specified by:

findBin in interface Histogram

Parameters:

x - spatial real-valued coordinate in X

y - spatial real-valued coordinate in Y

z - spatial real-valued coordinate in Z

Returns:

bin index corresponding to spatial x, y and z coordinates

getBinCenterX

public double getBinCenterX(int binX)

Specified by:

getBinCenterX in interface Histogram

Parameters:

binX - index

Returns:

bin centre for X axis

getBinCenterY

public double getBinCenterY(int binY)

Specified by:

getBinCenterY in interface Histogram

Parameters:

binY - index

Returns:

bin centre for X axis

getBinCenterZ

public double getBinCenterZ(int binZ)

Specified by:

getBinCenterZ in interface Histogram

Parameters:

binZ - index

Returns:

bin centre for X axis

reset

public void reset()

Description copied from interface: Histogram

reset histogram content

Specified by:

reset in interface Histogram

getDimension

public int getDimension()

Specified by:

getDimension in interface Histogram

Returns:

number of dimensions

getNBinsX

public int getNBinsX()

Specified by:

getNBinsX in interface Histogram

Returns:

number of bin alongside X axis

getNBinsY

public int getNBinsY()

Specified by:

getNBinsY in interface Histogram

Returns:

number of bin alongside Y axis

getNBinsZ

public int getNBinsZ()

Specified by:

getNBinsZ in interface Histogram

Returns:

number of bin alongside Z axis

set

public void set(int xIndex,
                int yIndex,
                double x,
                double y,
                double z)

Description copied from interface: DataSet3D

Changes a data point at specified index to new values.

Specified by:

set in interface DataSet3D

Parameters:

xIndex - the x-axis coordinate index of the data point to be changed

yIndex - the y-axis coordinate index of the data point to be changed

x - X coordinate

y - Y coordinate

z - value on the z-axis