Package etomica.modules.multiharmonic

Class DataProcessorBias

java.lang.Object

etomica.data.DataProcessor

etomica.modules.multiharmonic.DataProcessorBias

All Implemented Interfaces:

DataPipe, IDataSink

public class DataProcessorBias
extends DataProcessor

Data Processor which calculates the bias in the incoming data based on the true value of the free energy calculated from the

Field Summary

Fields

Modifier and Type	Field	Description
protected IData	data
protected IDataInfo	dataInfo
protected DataSourceScalar	trueDataSource

Fields inherited from class etomica.data.DataProcessor

dataSink, tag

Constructor Summary

Constructors

Constructor	Description
DataProcessorBias(DataSourceScalar trueDataSource)

Method Summary

Modifier and Type	Method	Description
protected IData	processData(IData inputData)	Processes the input Data and returns Data for pushing to the next DataSink.
protected IDataInfo	processDataInfo(IDataInfo inputDataInfo)	Informs this DataProcessor of the DataInfo for the Data it will be processing.

Methods inherited from class etomica.data.DataProcessor

getDataInfo, getDataSink, getTag, putData, putDataInfo, setDataSink

Methods inherited from class java.lang.Object

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

Field Detail

data

protected IData data

dataInfo

protected IDataInfo dataInfo

trueDataSource

protected DataSourceScalar trueDataSource

Constructor Detail

DataProcessorBias

public DataProcessorBias(DataSourceScalar trueDataSource)

Method Detail

processDataInfo

protected IDataInfo processDataInfo(IDataInfo inputDataInfo)

Description copied from class: DataProcessor

Informs this DataProcessor of the DataInfo for the Data it will be processing. Typically the subclass will use this information to make any objects or otherwise prepare for calls to processData.

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

processData

protected IData processData(IData inputData)

Description copied from class: DataProcessor

Processes the input Data and returns Data for pushing to the next DataSink. Returns null if output Data should not (yet) be pushed downstream.

Specified by:

processData in class DataProcessor

Parameters:

inputData - the Data for processing

Returns:

the processed Data, for sending downstream (if not null)