Package adams.gui.visualization.stats.probabilityplot

Class NormalPlotOptions

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.core.option.AbstractOptionGroup

adams.gui.visualization.stats.core.AbstractPlotOptionGroup

adams.gui.visualization.stats.probabilityplot.NormalPlotOptions

All Implemented Interfaces:

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

public class NormalPlotOptions
extends AbstractPlotOptionGroup

Class for setting the options for the normal probability plot

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
 

-regression-line (property: regLine)
    Display a linear regression line overlay
 

Version:

$Revision$

Author:

msf8

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_RegLine	Whether to display a regression diagonal line

Fields inherited from class adams.gui.visualization.stats.core.AbstractPlotOptionGroup

m_AxisX, m_AxisY

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Configures the options.
protected AxisPanelOptions	getDefaultAxisX()	Returns the setup for the X axis.
protected AxisPanelOptions	getDefaultAxisY()	Returns the setup for the Y axis.
protected String	getGroupName()	Returns the group name.
boolean	getRegLine()	Get whether a regression line should be drawn
String	regLineTipText()	Tip text for the regression line property
void	setRegLine(boolean val)	Set whether a regression line should be drawn

Methods inherited from class adams.gui.visualization.stats.core.AbstractPlotOptionGroup

axisXTipText, axisYTipText, getAxisX, getAxisY, setAxisX, setAxisY

Methods inherited from class adams.core.option.AbstractOptionGroup

globalInfo

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_RegLine

protected boolean m_RegLine

Whether to display a regression diagonal line

Constructor Detail

NormalPlotOptions

public NormalPlotOptions()

Method Detail

getGroupName

protected String getGroupName()

Returns the group name.

Specified by:

getGroupName in class AbstractOptionGroup

Returns:

the name

defineOptions

public void defineOptions()

Description copied from class: AbstractPlotOptionGroup

Configures the options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractPlotOptionGroup

getDefaultAxisX

protected AxisPanelOptions getDefaultAxisX()

Returns the setup for the X axis.

Specified by:

getDefaultAxisX in class AbstractPlotOptionGroup

Returns:

the setup

getDefaultAxisY

protected AxisPanelOptions getDefaultAxisY()

Returns the setup for the Y axis.

Specified by:

getDefaultAxisY in class AbstractPlotOptionGroup

Returns:

the setup

setRegLine

public void setRegLine(boolean val)

Set whether a regression line should be drawn

Parameters:

val - True if regression line drawn

getRegLine

public boolean getRegLine()

Get whether a regression line should be drawn

Returns:

regLineTipText

public String regLineTipText()

Tip text for the regression line property

Returns:

String describing the property