Package adams.data.filter

Class AbstractAutocorrelation<T extends DataContainer>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<T>

adams.data.filter.AbstractAutocorrelation<T>

Type Parameters:

T - the type of data to process

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Filter>, SizeOfHandler, Filter<T>, Serializable, Comparable

Direct Known Subclasses:

TimeseriesAutocorrelation

public abstract class AbstractAutocorrelation<T extends DataContainer>
extends AbstractFilter<T>

Abstract ancestor for autocorrelation filters.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.data.filter.AbstractFilter

AbstractFilter.FilterJob<T extends DataContainer>

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractAutoCorrelation	m_Algorithm	the algorithm to use.

Fields inherited from class adams.data.filter.AbstractFilter

m_DontUpdateID

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
AbstractAutocorrelation()

Method Summary

Modifier and Type	Method	Description
String	algorithmTipText()	Returns the tip text for this property.
protected void	checkData(T data)	The default implementation only checks whether there is any data set.
void	defineOptions()	Adds options to the internal list of options.
AbstractAutoCorrelation	getAlgorithm()	Returns the algorithm to use.
protected abstract double	getX(DataPoint point)	Returns the X value of the DataPoint.
protected abstract double	getY(DataPoint point)	Returns the Y value of the DataPoint.
protected abstract DataPoint	newDataPoint(double x, double y)	Creates a new DataPoint from the X/Y data.
protected T	processData(T data)	Performs the actual filtering.
void	setAlgorithm(AbstractAutoCorrelation value)	Sets the algorithm to use.

Methods inherited from class adams.data.filter.AbstractFilter

cleanUp, compareTo, destroy, dontUpdateIDTipText, equals, filter, forCommandLine, getDontUpdateID, reset, setDontUpdateID, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

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, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Algorithm

protected AbstractAutoCorrelation m_Algorithm

the algorithm to use.

Constructor Detail

AbstractAutocorrelation

public AbstractAutocorrelation()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractFilter<T extends DataContainer>

setAlgorithm

public void setAlgorithm(AbstractAutoCorrelation value)

Sets the algorithm to use.

Parameters:

value - the algorithm

getAlgorithm

public AbstractAutoCorrelation getAlgorithm()

Returns the algorithm to use.

Returns:

the algorithm

algorithmTipText

public String algorithmTipText()

Returns the tip text for this property.

Returns:

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

getX

protected abstract double getX(DataPoint point)

Returns the X value of the DataPoint.

Parameters:

point - the point to get the X value from

Returns:

the X value

getY

protected abstract double getY(DataPoint point)

Returns the Y value of the DataPoint.

Parameters:

point - the point to get the Y value from

Returns:

the Y value

newDataPoint

protected abstract DataPoint newDataPoint(double x,
                                          double y)

Creates a new DataPoint from the X/Y data.

Parameters:

x - the X of the data point

y - the Y of the data point

Returns:

the new DataPoint

checkData

protected void checkData(T data)

Description copied from class: AbstractFilter

The default implementation only checks whether there is any data set.

Overrides:

checkData in class AbstractFilter<T extends DataContainer>

Parameters:

data - the data to filter

processData

protected T processData(T data)

Performs the actual filtering.

Specified by:

processData in class AbstractFilter<T extends DataContainer>

Parameters:

data - the data to filter

Returns:

the filtered data