Package etomica.data.histogram

Class HistogramCollapsing

java.lang.Object

etomica.data.histogram.HistogramSimple

etomica.data.histogram.HistogramCollapsing

All Implemented Interfaces:

Histogram

public class HistogramCollapsing
extends HistogramSimple

Simple Histogram implementation with a static number of bins, but dynamic x range. If an x value is given that falls outside the histogram's x range, the histogram's range is expanded to include the given x value. The previously collected histogram is collapsed into fewer bins. The x range and number of bins can be changed explicitly, but doing so will reset the histogram (losing all previously collected data).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	firstValue
protected long	firstValueCount

Fields inherited from class etomica.data.histogram.HistogramSimple

counts, deltaX, histogram, nBins, sum, xMax, xMin, xValues

Constructor Summary

Constructors

Constructor	Description
HistogramCollapsing()	Default constructor, making a 100-bin histogram.
HistogramCollapsing(int n)	Makes a new histogram instance having a number of bins given by the argument.

Method Summary

Modifier and Type	Method	Description
void	addValue(double x)	Adds the given value to the Histogram
protected void	collapseData(double newX)	Collapses existing data and expands x range sufficiently so that the given x value is within the range of the histogram.
double[]	getHistogram()	Returns the histogram as an array of doubles
void	reset()	resets all histogram values and counts to zero
void	setXRange(DoubleRange xRange)	Sets the range of x values used in the histogram (min and max).

Methods inherited from class etomica.data.histogram.HistogramSimple

getBinCounts, getCount, getNBins, getXRange, setNBins, xValues

Methods inherited from class java.lang.Object

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

Field Detail

firstValue

protected double firstValue

firstValueCount

protected long firstValueCount

Constructor Detail

HistogramCollapsing

public HistogramCollapsing()

Default constructor, making a 100-bin histogram.

HistogramCollapsing

public HistogramCollapsing(int n)

Makes a new histogram instance having a number of bins given by the argument.

Method Detail

reset

public void reset()

Description copied from interface: Histogram

resets all histogram values and counts to zero

Specified by:

reset in interface Histogram

Overrides:

reset in class HistogramSimple

addValue

public void addValue(double x)

Description copied from interface: Histogram

Adds the given value to the Histogram

Specified by:

addValue in interface Histogram

Overrides:

addValue in class HistogramSimple

setXRange

public void setXRange(DoubleRange xRange)

Description copied from interface: Histogram

Sets the range of x values used in the histogram (min and max). The existing histogram may be dropped or redistributed to the new bins.

Specified by:

setXRange in interface Histogram

Overrides:

setXRange in class HistogramSimple

collapseData

protected void collapseData(double newX)

Collapses existing data and expands x range sufficiently so that the given x value is within the range of the histogram. The collapsing is done by taking the data from N bins and placing them into a single bin over the whole range. The resulting histogram is identical to the histogram that would have been collected if the resulting bin width had been used the whole time.

getHistogram

public double[] getHistogram()

Description copied from interface: Histogram

Returns the histogram as an array of doubles

Specified by:

getHistogram in interface Histogram

Overrides:

getHistogram in class HistogramSimple