Package adams.flow.control.plotprocessor

Class LOWESS

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.control.plotprocessor.AbstractPlotProcessor

adams.flow.control.plotprocessor.AbstractPlotProcessorWithBuffer<Point2D>

adams.flow.control.plotprocessor.LOWESS

All Implemented Interfaces:

CleanUpHandler, Destroyable, ErrorProvider, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, TechnicalInformationHandler, Serializable

public class LOWESS
extends AbstractPlotProcessorWithBuffer<Point2D>
implements TechnicalInformationHandler

A processor that applies LOWESS smoothing.

For more information see:

WikiPedia. Local Regression. URL http://en.wikipedia.org/wiki/Lowess.

 @misc{missing_id,
    author = {WikiPedia},
    title = {Local Regression},
    URL = {http://en.wikipedia.org/wiki/Lowess}
 }
 

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

-plot-name-suffix <java.lang.String> (property: plotNameSuffix)
    The suffix for the plot name; if left empty, the plot container automatically 
    becomes an OVERLAY.
    default: 
 

-window-size <int> (property: windowSize)
    The window size to use, must be at least 20.
    default: 20
    minimum: 1
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_WindowSize	Size of window size for calculating lowess.

Fields inherited from class adams.flow.control.plotprocessor.AbstractPlotProcessorWithBuffer

m_Data, m_LastPlot, m_XIndex

Fields inherited from class adams.flow.control.plotprocessor.AbstractPlotProcessor

m_LastError, m_PlotNameSuffix

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected List<SequencePlotterContainer>	doProcess(SequencePlotterContainer cont)	Processes the provided container.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
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.
void	setWindowSize(int value)	Sets the polynomial order.
String	windowSizeTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.control.plotprocessor.AbstractPlotProcessorWithBuffer

cleanUp, initialize, postProcess, preProcess, reset

Methods inherited from class adams.flow.control.plotprocessor.AbstractPlotProcessor

check, getLastError, getPlotName, getPlotNameSuffix, getPlotType, hasLastError, isValid, plotNameSuffixTipText, process, setPlotNameSuffix

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_WindowSize

protected int m_WindowSize

Size of window size for calculating lowess.

Constructor Detail

LOWESS

public LOWESS()

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 AbstractPlotProcessor

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.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractPlotProcessor

Returns:

null if no info available, otherwise short string

doProcess

protected List<SequencePlotterContainer> doProcess(SequencePlotterContainer cont)

Processes the provided container. Generates new containers if applicable.

Specified by:

doProcess in class AbstractPlotProcessor

Parameters:

cont - the container to process

Returns:

null if no new containers were produced