Package adams.data.smoothing

Class AbstractCenteredMovingAverageBased<T extends DataContainer>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.smoothing.AbstractSmoother<T>

adams.data.smoothing.AbstractCenteredMovingAverageBased<T>

Type Parameters:

T - the type of data to smooth

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractSmoother>, SizeOfHandler, TechnicalInformationHandler, Serializable, Comparable

public abstract class AbstractCenteredMovingAverageBased<T extends DataContainer>
extends AbstractSmoother<T>
implements TechnicalInformationHandler

Abstract ancestor for Centered Moving Average based smoothers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.smoothing.AbstractSmoother

AbstractSmoother.SmootherJob<T extends DataContainer>

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractCenteredMovingAverage	m_CenteredMovingAverage	the CenteredMovingAverage filter in use.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractCenteredMovingAverageBased()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected abstract AbstractCenteredMovingAverage	getDefault()	Returns the default CenteredMovingAverage filter.
TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
int	getWindowSize()	Returns the window size.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
protected T	processData(T data)	Performs the actual smoothing.
void	setWindowSize(int value)	Sets the window size.
String	windowSizeTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.smoothing.AbstractSmoother

checkData, cleanUp, compareTo, destroy, equals, forCommandLine, forName, getSmoothers, reset, shallowCopy, shallowCopy, smooth

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_CenteredMovingAverage

protected AbstractCenteredMovingAverage m_CenteredMovingAverage

the CenteredMovingAverage filter in use.

Constructor Detail

AbstractCenteredMovingAverageBased

public AbstractCenteredMovingAverageBased()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getDefault

protected abstract AbstractCenteredMovingAverage getDefault()

Returns the default CenteredMovingAverage filter.

Returns:

the default filter

getTechnicalInformation

public TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface TechnicalInformationHandler

Returns:

the technical information about this class

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setWindowSize

public void setWindowSize(int value)

Sets the window size.

Parameters:

value - the window size

getWindowSize

public int getWindowSize()

Returns the window size.

Returns:

the window size

windowSizeTipText

public String windowSizeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

processData

protected T processData(T data)

Performs the actual smoothing.

Specified by:

processData in class AbstractSmoother<T extends DataContainer>

Parameters:

data - the to smooth

Returns:

the smoothed data