Package etomica.data

Class DataTableAverages

java.lang.Object

etomica.data.DataSet

etomica.data.DataSinkTable

etomica.data.DataTableAverages

public class DataTableAverages
extends DataSinkTable

Convenience class for a data table that collects the AccumulatorAverage statistics for a collection of DataSource instances. Permits convenient setup of accumulator and piping of data. Data sources may be specified at construction or added afterward. For each source added, this class automatically constructs an AccumulatorAverage, arranges for pumping of data from source to accumulator, and from accumulator to a column in this table.

Nested Class Summary

Nested classes/interfaces inherited from class etomica.data.DataSet

DataSet.DataSetSink

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.ArrayList<DataPump>	dataPumps

Fields inherited from class etomica.data.DataSet

backwardDataMap, forwardDataMap, listeners, psuedoSinks

Constructor Summary

Constructors

Constructor	Description
DataTableAverages(Integrator integrator)	Sets up table with default types that give the current value, the average, and the error bars.
DataTableAverages(Integrator integrator, int blockSize, java.util.ArrayList<DataPump> dataPumps)
DataTableAverages(Integrator integrator, AccumulatorAverage.StatType[] types, int blockSize, IDataSource[] sources, java.util.ArrayList<DataPump> dataPumps)	Sets up table with no sources.

Method Summary

Modifier and Type	Method	Description
void	addDataSource(IDataSource newSource)	Adds the given data source to those feeding the table.
AccumulatorAverage[]	getAccumulators()	Returns a clone of the accumulator array.
int	getAccumulatorUpdateInterval()
int	getTableUpdateInterval()
void	setAccumulatorUpdateInterval(int accumulatorUpdateInterval)	Sets the interval for updates to the accumulators feeding this table.
void	setTableUpdateInterval(int tableUpdateInterval)	Sets the interval for updating the table.

Methods inherited from class etomica.data.DataSet

addDataListener, fireDataChangedEvent, fireDataCountChangedEvent, getData, getDataCount, getDataInfo, getName, isUpdatingOnAnyChange, makeDataSink, makeDataSink, removeDataListener, reset, setUpdatingOnAnyChange, updateDataMap

Methods inherited from class etomica.data.DataSinkTable

dataChanged, dataInfoChanged, fireRowCountChangedEvent, getRowCount, getRowHeader, getValue, makeDataSink

Methods inherited from class java.lang.Object

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

Field Detail

dataPumps

protected final java.util.ArrayList<DataPump> dataPumps

Constructor Detail

DataTableAverages

public DataTableAverages(Integrator integrator)

Sets up table with default types that give the current value, the average, and the error bars.

DataTableAverages

public DataTableAverages(Integrator integrator,
                         int blockSize,
                         java.util.ArrayList<DataPump> dataPumps)

DataTableAverages

public DataTableAverages(Integrator integrator,
                         AccumulatorAverage.StatType[] types,
                         int blockSize,
                         IDataSource[] sources,
                         java.util.ArrayList<DataPump> dataPumps)

Sets up table with no sources.

Method Detail

addDataSource

public void addDataSource(IDataSource newSource)

Adds the given data source to those feeding the table.

getTableUpdateInterval

public int getTableUpdateInterval()

Returns:

Returns the table update interval.

setTableUpdateInterval

public void setTableUpdateInterval(int tableUpdateInterval)

Sets the interval for updating the table. The table receives values from the accumulators only after they have received this many data values from their sources. This value does not affect the averages, only the frequency that they are piped to the table. Default is 100.

getAccumulatorUpdateInterval

public int getAccumulatorUpdateInterval()

Returns:

Returns the accumulatorUpdateInterval.

setAccumulatorUpdateInterval

public void setAccumulatorUpdateInterval(int accumulatorUpdateInterval)

Sets the interval for updates to the accumulators feeding this table. Accumulators receive new data only after the integrator fires this many interval events. This value affects the averages. Default is 1.

getAccumulators

public AccumulatorAverage[] getAccumulators()

Returns a clone of the accumulator array. Fields in the accumulators may be modified to affect the behavior of the accumulators. Note that pushInterval of all accumulators can be changed via setTableUpdate.