Package adams.data.filter

Class AbstractSimpleSavitzkyGolay<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.AbstractSimpleSavitzkyGolay<T>

Type Parameters:

T - the type of data to process

All Implemented Interfaces:

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

public abstract class AbstractSimpleSavitzkyGolay<T extends DataContainer>
extends AbstractFilter<T>
implements TechnicalInformationHandler

Abstract ancestor for simple Savitzky-Golay filters.

Version:

$Revision$

Author:

dale (dale 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 int	m_WindowSize	window size.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
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.
protected abstract double	getValue(DataPoint point)	Returns the Y-value of the point.
int	getWindowSize()	Returns the size of the window.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
protected abstract DataPoint	newDataPoint(DataPoint old, double y)	Creates a new DataPoint based on the old one and the new Y-value.
protected T	processData(T data)	Performs the actual filtering.
void	setWindowSize(int value)	Sets the maximum size of the window to optimize (odd, positive number).
String	windowSizeTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.filter.AbstractFilter

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

Methods inherited from class adams.core.option.AbstractOptionHandler

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

protected int m_WindowSize

window size.

Constructor Detail

AbstractSimpleSavitzkyGolay

public AbstractSimpleSavitzkyGolay()

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

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 AbstractFilter<T extends DataContainer>

setWindowSize

public void setWindowSize(int value)

Sets the maximum size of the window to optimize (odd, positive number).

Parameters:

value - the size

getWindowSize

public int getWindowSize()

Returns the size of the window.

Returns:

the 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.

getValue

protected abstract double getValue(DataPoint point)

Returns the Y-value of the point.

Parameters:

point - the DataPoint to get the Y-value from

Returns:

the Y-value

newDataPoint

protected abstract DataPoint newDataPoint(DataPoint old,
                                          double y)

Creates a new DataPoint based on the old one and the new Y-value.

Parameters:

old - the old DataPoint

y - the new Y-value

Returns:

the new DataPoint

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