Package etomica.data

Class AccumulatorHistogram

java.lang.Object

etomica.data.DataProcessor

etomica.data.DataProcessorForked

etomica.data.DataAccumulator

etomica.data.AccumulatorHistogram

All Implemented Interfaces:

DataPipe, DataPipeForked, IDataSink, IDataSource

public class AccumulatorHistogram
extends DataAccumulator

Accumulator that keeps histogram of data.

Input Data must implement DataArithmetic.

Field Summary

Fields

Modifier and Type	Field	Description
protected Histogram	histogram
protected DataSourceIndependentSimple	xDataSource

Fields inherited from class etomica.data.DataAccumulator

active, hasUnpushedData, pushInterval, putCount

Fields inherited from class etomica.data.DataProcessor

dataInfo, dataSink, tag

Constructor Summary

Constructors

Constructor	Description
AccumulatorHistogram()	Creates instance using HistogramSimple factory and specifying histograms having 100 bins.
AccumulatorHistogram(Histogram histogram)	Creates instance using given histogram factory with default nBins of 100.
AccumulatorHistogram(Histogram histogram, int nBins)	Creates instance using the given histogram factory making histograms having the given number of bins.

Method Summary

Modifier and Type	Method	Description
protected boolean	addData(IData inputData)	Adds each value in the given Data to its own histogram.
IData	getData()	Returns the set of histograms.
IDataInfo	getDataInfo()	Returns the DataInfo for the output Data.
Histogram	getHistograms()
int	getNBins()
protected IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Sets up data and histograms, discarding any previous results.
void	reset()	Zeros histograms, discarding any previous contributions.
void	setHistogram(Histogram newHistogram)
void	setNBins(int nBins)	Sets the number of bins in each histogram.

Methods inherited from class etomica.data.DataAccumulator

getPushInterval, isActive, processData, setActive, setPushInterval, toString

Methods inherited from interface etomica.data.DataPipe

getTag

Methods inherited from class etomica.data.DataProcessor

getTag, putData, putDataInfo

Methods inherited from class etomica.data.DataProcessorForked

addDataSink, getDataSink, getDataSinks, removeDataSink, setDataSink, setDataSinks

Methods inherited from interface etomica.data.IDataSink

putData, putDataInfo

Methods inherited from interface etomica.data.IDataSource

getTag

Methods inherited from class java.lang.Object

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

Field Detail

histogram

protected Histogram histogram

xDataSource

protected DataSourceIndependentSimple xDataSource

Constructor Detail

AccumulatorHistogram

public AccumulatorHistogram()

Creates instance using HistogramSimple factory and specifying histograms having 100 bins.

AccumulatorHistogram

public AccumulatorHistogram(Histogram histogram)

Creates instance using given histogram factory with default nBins of 100.

AccumulatorHistogram

public AccumulatorHistogram(Histogram histogram,
                            int nBins)

Creates instance using the given histogram factory making histograms having the given number of bins.

Method Detail

addData

protected boolean addData(IData inputData)

Adds each value in the given Data to its own histogram.

Specified by:

addData in class DataAccumulator

Parameters:

inputData - the data to be processed

Returns:

true if the Accumulator's getData method will now return different data.

getData

public IData getData()

Returns the set of histograms.

Specified by:

getData in interface IDataSource

Specified by:

getData in class DataAccumulator

Returns:

the data given by this source

processDataInfo

protected IDataInfo processDataInfo(IDataInfo inputDataInfo)

Sets up data and histograms, discarding any previous results.

Specified by:

processDataInfo in class DataProcessor

Parameters:

inputDataInfo - the DataInfo of the Data that will be input to this DataProcessor

Returns:

the DataInfo of the Data that will be output by this DataProcessor

getNBins

public int getNBins()

Returns:

the number of bins in each histogram.

setNBins

public void setNBins(int nBins)

Sets the number of bins in each histogram. Calls setNBins method of current histograms, which will discard data or modify themselves depending on how they are defined.

reset

public void reset()

Zeros histograms, discarding any previous contributions.

Specified by:

reset in class DataAccumulator

getHistograms

public Histogram getHistograms()

setHistogram

public void setHistogram(Histogram newHistogram)

getDataInfo

public IDataInfo getDataInfo()

Returns the DataInfo for the output Data.

Specified by:

getDataInfo in interface IDataSource

Overrides:

getDataInfo in class DataProcessor