Package de.gsi.dataset

Interface Histogram2D

All Known Implementing Classes:

Histogram2

public interface Histogram2D

Author:

rstein

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)

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

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

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