|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.layer.BinBag
public class BinBag
Data model for a one-dimensional histogram. Linear and logarithmic axis scaling are supported.
Nested Class Summary | |
---|---|
static interface |
BinBag.Bin
Describes the extent of a bin and the value it contains. |
Constructor Summary | |
---|---|
BinBag(boolean log,
double binWidth,
double binPhase,
double point)
Constructor. |
Method Summary | |
---|---|
void |
addToBin(double point,
double inc)
Adds a value to the bin in which a given point falls. |
Iterator<double[]> |
barIterator(double lo,
double hi)
Iterates over all the bins defined by this bin bag in a given data interval. |
Iterator<BinBag.Bin> |
binIterator(boolean cumulative,
Normalisation norm)
Returns a sorted iterator over all bins with non-zero values. |
double |
getBinWidth()
Returns the bin width used by this histogram model. |
boolean |
matches(boolean log,
double binWidth,
double binPhase)
Indicates whether the bin boundaries used by this object are the same as a given bin set specification. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BinBag(boolean log, double binWidth, double binPhase, double point)
log=false
:
binWidth*(0+binPhase), binWidth*(1+binPhase), ...and for
log=true
:
binWidth**(0+binPhase), binWidth**(1+binPhase), ...
The point
parameter is used internally to determine
the zero point of the bins. In principle this should make no
difference to behaviour, but in case that the data is situated
a very long way from 1, setting it close to
the actual data point locations may avoid rounding errors.
log
- false for linear axis scaling, true for logarithmicbinWidth
- width of each bin; this is additive for linear
and multiplicative for logarithmic scalingbinPhase
- determines sub-bin boundary shifts along axis,
normally in range 0..1point
- representative point on axis near which bins are
situatedMethod Detail |
---|
public void addToBin(double point, double inc)
point
- axis coordinateinc
- value to accumulate onto bin valuepublic Iterator<BinBag.Bin> binIterator(boolean cumulative, Normalisation norm)
cumulative
- true for bins of a cumulative histogramnorm
- normalisation mode
public Iterator<double[]> barIterator(double lo, double hi)
lo
- lower bound of interesthi
- upper bound of interest
public double getBinWidth()
public boolean matches(boolean log, double binWidth, double binPhase)
log
- false for linear scaling, true for logarithmicbinWidth
- width of each bin; this is additive for linear
and multiplicative for logarithmic scalingbinPhase
- determines sub-bin boundary shifts along axis
normally in range 0..1
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |