Package adams.data.filter

Class AbstractLOWESS<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.AbstractLOWESS<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

Direct Known Subclasses:

TimeseriesLOWESS

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

Abstract ancestor for LOWESS filters.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz), Michael Fowke (msf8 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	Size of window size for calculating lowess.

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

Method Summary

Modifier and Type	Method	Description
protected abstract Point2D	convert(DataPoint point)	Returns the X/Y values of the DataPoint as Point2D.
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.
int	getWindowSize()	Returns the polynominal order.
String	globalInfo()	Returns a string describing the object.
protected abstract DataPoint	newDataPoint(Point2D smoothed)	Creates a new DataPoint from the smoothed one.
protected T	processData(T data)	Performs the actual filtering.
void	setWindowSize(int value)	Sets the polynomial order.
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, 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_WindowSize

protected int m_WindowSize

Size of window size for calculating lowess.

Constructor Detail

AbstractLOWESS

public AbstractLOWESS()

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

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 polynomial order.

Parameters:

value - the order

getWindowSize

public int getWindowSize()

Returns the polynominal order.

Returns:

the order

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.

convert

protected abstract Point2D convert(DataPoint point)

Returns the X/Y values of the DataPoint as Point2D.

Parameters:

point - the point to get the X/Y values from

Returns:

the X/Y values as Point2D

newDataPoint

protected abstract DataPoint newDataPoint(Point2D smoothed)

Creates a new DataPoint from the smoothed one.

Parameters:

smoothed - the smoothed data point

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