org.das2.dataset

Class RebinDescriptor

java.lang.Object

org.das2.dataset.RebinDescriptor

public final class RebinDescriptor
extends java.lang.Object

The RebinDescriptor will quickly look up which 1-D bin a Datum is in. This is not thread-safe, and must be used by only one thread during its lifetime.

Field Summary

Fields

Modifier and Type	Field and Description
protected double	end
static int	EXTRAPOLATE
static int	FIRSTORLAST
protected boolean	isLog
static int	MINUSONE
protected int	nBin
protected double	start

Constructor Summary

Constructors

Constructor and Description
RebinDescriptor(Datum start, Datum end, int nBin, boolean isLog)
RebinDescriptor(double start, double end, Units units, int nBin, boolean isLog)

Method Summary

Modifier and Type	Method and Description
Datum	binCenter(int ibin)
double	binCenter(int ibin, Units units)
double[]	binCenters()
DatumVector	binCentersDV()
Datum	binStart(int ibin)
double	binStart(int ibin, Units units) return the smaller boundary of the bin.
double[]	binStarts() return the bin starts of all bins, in units of getUnits()
Datum	binStop(int ibin)
double	binStop(int ibin, Units units) return the bigger boundary of the bin.
double[]	binStops() return the bin stops of all bins, in units of getUnits()
double	binWidth()
Datum	binWidthDatum()
static RebinDescriptor	createSubsumingRebinDescriptor(RebinDescriptor ddY, Datum ymin, Datum ymax)
Units	getUnits()
boolean	isLog()
int	numberOfBins()
static void	putDepDataSet(QDataSet ds, MutablePropertyDataSet result, RebinDescriptor ddX, RebinDescriptor ddY) taken from AverageTableRebinner
void	setOutOfBoundsAction(int action)
java.lang.String	toString()
int	whichBin(double x, Units units)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

start

protected double start

end

protected double end

nBin

protected int nBin

isLog

protected boolean isLog

FIRSTORLAST

public static final int FIRSTORLAST

See Also:

Constant Field Values

MINUSONE

public static final int MINUSONE

See Also:

Constant Field Values

EXTRAPOLATE

public static final int EXTRAPOLATE

See Also:

Constant Field Values

Constructor Detail

RebinDescriptor

public RebinDescriptor(double start,
                       double end,
                       Units units,
                       int nBin,
                       boolean isLog)

RebinDescriptor

public RebinDescriptor(Datum start,
                       Datum end,
                       int nBin,
                       boolean isLog)

Method Detail

numberOfBins

public int numberOfBins()

whichBin

public int whichBin(double x,
                    Units units)

binCentersDV

public DatumVector binCentersDV()

binCenters

public double[] binCenters()

binCenter

public double binCenter(int ibin,
                        Units units)

binCenter

public Datum binCenter(int ibin)

binStart

public Datum binStart(int ibin)

binStart

public double binStart(int ibin,
                       Units units)

return the smaller boundary of the bin.

Parameters:

ibin - the bin number

units - the units for the result.

Returns:

the smaller boundary of the bin in the desired units.

binStop

public Datum binStop(int ibin)

binStop

public double binStop(int ibin,
                      Units units)

return the bigger boundary of the bin.

Parameters:

ibin - the bin number

units - the units for the result.

Returns:

the bigger boundary of the bin in the desired units.

binStarts

public double[] binStarts()

return the bin starts of all bins, in units of getUnits()

Returns:

the bin starts of all bins

binStops

public double[] binStops()

return the bin stops of all bins, in units of getUnits()

Returns:

the bin stops of all bins

setOutOfBoundsAction

public void setOutOfBoundsAction(int action)

createSubsumingRebinDescriptor

public static RebinDescriptor createSubsumingRebinDescriptor(RebinDescriptor ddY,
                                                             Datum ymin,
                                                             Datum ymax)

binWidth

public double binWidth()

binWidthDatum

public Datum binWidthDatum()

isLog

public boolean isLog()

getUnits

public Units getUnits()

putDepDataSet

public static void putDepDataSet(QDataSet ds,
                                 MutablePropertyDataSet result,
                                 RebinDescriptor ddX,
                                 RebinDescriptor ddY)

taken from AverageTableRebinner

Parameters:

ds - the original dataset

result - the rank 2 rebin target.

ddX - the descriptor, or null.

ddY - the descriptor, or null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object