Package adams.data.baseline

Class AbstractLOWESSBased<T extends DataContainer>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.baseline.AbstractBaselineCorrection<T>

adams.data.baseline.AbstractLOWESSBased<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

TimeseriesLOWESSBased

public abstract class AbstractLOWESSBased<T extends DataContainer>
extends AbstractBaselineCorrection<T>

Ancestor for LOWESS-based baseline correction schemes.

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.baseline.AbstractBaselineCorrection

AbstractBaselineCorrection.BaselineCorrectionJob<T extends DataContainer>

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractLOWESS	m_Filter	the filter to 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
AbstractLOWESSBased()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected abstract AbstractLOWESS	getFilter()	Returns a new instance of a LOWESS 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 polynominal order.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
protected T	processData(T data)	Performs the actual correcting.
void	setWindowSize(int value)	Sets the polynomial order.
protected abstract DataPoint	subtract(DataPoint old, DataPoint baseline)	Subtracts the baseline from the old data point and creates a new data point.
String	windowSizeTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.baseline.AbstractBaselineCorrection

checkData, cleanUp, compareTo, correct, doCorrect, equals, forCommandLine, reset, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, 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

Field Detail

m_Filter

protected AbstractLOWESS m_Filter

the filter to use.

Constructor Detail

AbstractLOWESSBased

public AbstractLOWESSBased()

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.

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 AbstractOptionHandler

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

getFilter

protected abstract AbstractLOWESS getFilter()

Returns a new instance of a LOWESS filter.

Returns:

the filter

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.

subtract

protected abstract DataPoint subtract(DataPoint old,
                                      DataPoint baseline)

Subtracts the baseline from the old data point and creates a new data point.

Parameters:

old - the old data point to subtract the baseline from

baseline - the baseline value to subtract

Returns:

the new corrected data point

processData

protected T processData(T data)

Performs the actual correcting.

Specified by:

processData in class AbstractBaselineCorrection<T extends DataContainer>

Parameters:

data - the data to correct

Returns:

the corrected data