Package adams.gui.visualization.stats.scatterplot

Class Lowess

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay

adams.gui.visualization.stats.scatterplot.Lowess

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, TechnicalInformationHandler, Serializable

public class Lowess
extends AbstractScatterPlotOverlay
implements TechnicalInformationHandler

Display a lowess curve as an overlay.
WikiPedia. Local Regression. URL http://en.wikipedia.org/wiki/Lowess.

BibTeX:

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

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-line-thickness <float> (property: thickness)
    Thickness of the overlay line
    default: 2.0
    minimum: 1.0
    maximum: 5.0
 

-color <java.awt.Color> (property: color)
    Color of the overlay line
    default: #0000ff
 

-window-size <int> (property: windowSize)
    Set the size of the data window for lowess fitting
    default: 120
    minimum: 20
 

Version:

$Revision$

Author:

msf8

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay

m_Color, m_Data, m_Paintlet, m_Parent, m_Thickness

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.
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()	get the size of the data window.
String	globalInfo()	Returns a string describing the object.
void	setUp()	set up the overlay and its paintlet.
void	setWindowSize(int value)	Set the size of the data window for the lowess fitting.
String	windowSizeTipText()	Returns a tip text for the data window size property.

Methods inherited from class adams.gui.visualization.stats.scatterplot.AbstractScatterPlotOverlay

colorTipText, getColor, getDefaultColor, getDefaultThickness, getPaintlet, getParent, getThickness, inst, name, setColor, setParent, setThickness, shallowCopy, shallowCopy, thicknessTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, 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 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 AbstractScatterPlotOverlay

setWindowSize

public void setWindowSize(int value)

Set the size of the data window for the lowess fitting.

Parameters:

value - Size of data window

getWindowSize

public int getWindowSize()

get the size of the data window.

Returns:

size of the data window

windowSizeTipText

public String windowSizeTipText()

Returns a tip text for the data window size property.

Returns:

String explaining the property

setUp

public void setUp()

set up the overlay and its paintlet.

Specified by:

setUp in class AbstractScatterPlotOverlay