Package de.gsi.dataset

Interface Histogram2D

All Superinterfaces:

DataSet, EventSource, GridDataSet, java.io.Serializable

All Known Implementing Classes:

Histogram2

public interface Histogram2D
extends GridDataSet

Author:

rstein

Field Summary

Fields inherited from interface de.gsi.dataset.DataSet

DIM_X, DIM_Y, DIM_Z

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	findBin(double x, double y)
int	findFirstBinAbove(double x, double y)
default double	getZ(int xIndex, int yIndex)	Returns Z coordinate for the specified data point.

Methods inherited from interface de.gsi.dataset.DataSet

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

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

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

Methods inherited from interface de.gsi.dataset.GridDataSet

get, getGrid, getGridIndex, getGridValues, getNGrid, getShape, getShape

Method Detail

fill

int fill(double x,
         double y)

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

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

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

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

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

findBin

int findBin(double x,
            double y)

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

findFirstBinAbove

int findFirstBinAbove(double x,
                      double y)

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

getZ

default double getZ(int xIndex,
                    int yIndex)

Returns Z coordinate for the specified data point.

Parameters:

xIndex - index of X coordinate

yIndex - index of Y coordinate

Returns:

Z coordinate