Package adams.data.filter

Class TimeseriesAutocorrelation

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.filter.AbstractFilter<T>

adams.data.filter.AbstractAutocorrelation<Timeseries>

adams.data.filter.TimeseriesAutocorrelation

All Implemented Interfaces:

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

public class TimeseriesAutocorrelation
extends AbstractAutocorrelation<Timeseries>

Performs autocorrelation on the timeseries.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-no-id-update <boolean> (property: dontUpdateID)
    If enabled, suppresses updating the ID of adams.data.id.IDHandler data containers.
    default: false
 

-algorithm <adams.data.autocorrelation.AbstractAutoCorrelation> (property: algorithm)
    The autocorrelation algorithm to use.
    default: adams.data.autocorrelation.BruteForce
 

Version:

$Revision: 7305 $

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 inherited from class adams.data.filter.AbstractAutocorrelation

m_Algorithm

Fields inherited from class adams.data.filter.AbstractFilter

m_DontUpdateID, m_DontUpdateProcessingInfo

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

Method Summary

Modifier and Type	Method	Description
protected double	getX(DataPoint point)	Returns the X value of the DataPoint.
protected double	getY(DataPoint point)	Returns the Y value of the DataPoint.
String	globalInfo()	Returns a string describing the object.
protected DataPoint	newDataPoint(double x, double y)	Creates a new DataPoint from the X/Y data.

Methods inherited from class adams.data.filter.AbstractAutocorrelation

algorithmTipText, checkData, defineOptions, getAlgorithm, processData, setAlgorithm

Methods inherited from class adams.data.filter.AbstractFilter

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, 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, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Constructor Detail

TimeseriesAutocorrelation

public TimeseriesAutocorrelation()

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

getX

protected double getX(DataPoint point)

Returns the X value of the DataPoint.

Specified by:

getX in class AbstractAutocorrelation<Timeseries>

Parameters:

point - the point to get the X value from

Returns:

the X value

getY

protected double getY(DataPoint point)

Returns the Y value of the DataPoint.

Specified by:

getY in class AbstractAutocorrelation<Timeseries>

Parameters:

point - the point to get the Y value from

Returns:

the Y value

newDataPoint

protected DataPoint newDataPoint(double x,
                                 double y)

Creates a new DataPoint from the X/Y data.

Specified by:

newDataPoint in class AbstractAutocorrelation<Timeseries>

Parameters:

x - the X of the data point

y - the Y of the data point

Returns:

the new DataPoint