Package adams.gui.visualization.stats.paintlet

Class MeanPaintlet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.AbstractStrokePaintlet

adams.gui.visualization.stats.paintlet.AbstractColorPaintlet

adams.gui.visualization.stats.paintlet.AbstractZOverlayPaintlet

adams.gui.visualization.stats.paintlet.MeanPaintlet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, Serializable

public class MeanPaintlet
extends AbstractZOverlayPaintlet

paintlet for displaying mean overlay on the ZScore graph

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
 

-stroke-thickness <float> (property: strokeThickness)
    The thickness of the stroke.
    default: 1.0
    minimum: 0.01
 

-color <java.awt.Color> (property: color)
    Stroke color for the paintlet
    default: #000000
 

Version:

$Revision$

Author:

msf8

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Mean	mean of the data set

Fields inherited from class adams.gui.visualization.stats.paintlet.AbstractZOverlayPaintlet

m_AxisBottom, m_AxisLeft, m_Calculated, m_Ind

Fields inherited from class adams.gui.visualization.stats.paintlet.AbstractColorPaintlet

m_Color, m_Data

Fields inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

m_StrokeThickness

Fields inherited from class adams.gui.visualization.core.AbstractPaintlet

m_Enabled, m_Initializing, m_Panel, m_RepaintOnChange

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

Method Summary

Modifier and Type	Method	Description
void	calculate()	calculates the data for the paintlet, doesn't handle the drawing of the data
protected void	drawData(Graphics g)	Draw the overlay onto the z score plot, only calculates the value to position in this method
String	globalInfo()	Returns a string describing the object.
void	setStd(double val)	set the number of standard deviations for the overlay only relevant for the stddev overlay

Methods inherited from class adams.gui.visualization.stats.paintlet.AbstractZOverlayPaintlet

doPerformPaint, getCalculated, getPaintMoment, initialize, parameters, setCalculated

Methods inherited from class adams.gui.visualization.stats.paintlet.AbstractColorPaintlet

colorTipText, defineOptions, getColor, getData, setColor, setData

Methods inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

applyStroke, getStrokeThickness, getStrokeWidth, performPaint, setStrokeThickness, strokeThicknessTipText

Methods inherited from class adams.gui.visualization.core.AbstractPaintlet

canPaint, finishInit, forCommandLine, forName, getPaintlets, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, isInitializing, memberChanged, memberChanged, paint, repaint, setEnabled, setPanel, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, getDefaultLoggingLevel, getOptionManager, 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_Mean

protected double m_Mean

mean of the data set

Constructor Detail

MeanPaintlet

public MeanPaintlet()

Method Detail

drawData

protected void drawData(Graphics g)

Description copied from class: AbstractZOverlayPaintlet

Draw the overlay onto the z score plot, only calculates the value to position in this method

Specified by:

drawData in class AbstractZOverlayPaintlet

Parameters:

g - graphics to draw on

globalInfo

public String globalInfo()

Description copied from class: AbstractOptionHandler

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

setStd

public void setStd(double val)

Description copied from class: AbstractZOverlayPaintlet

set the number of standard deviations for the overlay only relevant for the stddev overlay

Specified by:

setStd in class AbstractZOverlayPaintlet

Parameters:

val - number of std dev from mean

calculate

public void calculate()

Description copied from class: AbstractZOverlayPaintlet

calculates the data for the paintlet, doesn't handle the drawing of the data

Overrides:

calculate in class AbstractZOverlayPaintlet