adams.gui.visualization.stats.paintlet
Class MeanPaintlet

java.lang.Object
  adams.core.ConsoleObject
      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:

Debuggable, Destroyable, 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: 4584 $

Author:

msf8

See Also:

Serialized Form

Field Summary

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_Instances

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_DebugLevel, m_OptionManager

Constructor Summary

MeanPaintlet()

Method Summary

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

getCalculated, getPaintMoment, initialize, parameters, performPaint, setCalculated

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

colorTipText, defineOptions, getColor, getInstances, setColor, setInstances

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

getStrokeThickness, paint, setStrokeThickness, strokeThicknessTipText

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

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

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Specified by:

globalInfo in class AbstractOptionHandler

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