adams.gui.visualization.stats.paintlet
Class AbstractProbabilityPaintlet

java.lang.Object
  extended by adams.core.ConsoleObject
      extended by adams.core.option.AbstractOptionHandler
          extended by adams.gui.visualization.core.AbstractPaintlet
              extended by adams.gui.visualization.core.AbstractStrokePaintlet
                  extended by adams.gui.visualization.stats.paintlet.AbstractColorPaintlet
                      extended by adams.gui.visualization.stats.paintlet.AbstractProbabilityPaintlet
All Implemented Interfaces:
Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, AntiAliasingPaintlet, Paintlet, Serializable
Direct Known Subclasses:
Exponential, Gamma, Logistic, Loglogistic, Lognormal, Normal

public abstract class AbstractProbabilityPaintlet
extends AbstractColorPaintlet
implements AntiAliasingPaintlet

Abstract class for paintlets that plot the regression in the probability plot.

Version:
$Revision: 6343 $
Author:
msf8
See Also:
Serialized Form

Field Summary
protected  boolean m_AntiAliasingEnabled
          whether anti-aliasing is enabled.
protected  AxisPanel m_AxisBottom
          y axis of the plot
protected  AxisPanel m_AxisLeft
          x axis of the plot
protected  double[] m_Data
          the sorted data.
protected  boolean m_Fill
          Whether to fill the data points
protected  Color m_FillColor
          Color to fill data points
protected  int m_Index
          Index of the attribute in the instances
protected  boolean m_RegressionLine
          Whether to draw a regression line
protected  int m_Size
          Size of the points
protected  double[] m_TransformedY
          Transformed data for the y axis
 
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
AbstractProbabilityPaintlet()
           
 
Method Summary
 String antiAliasingEnabledTipText()
          Returns the tip text for this property.
abstract  void calculateDimensions()
          For calculating the dimensions of the plot area.
abstract  void configureAxes()
          Sets the axes to the correct type for the distribution.
 void defineOptions()
          Adds options to the internal list of options.
 String fillColorTipText()
          Tip text for the fill color property
 String fillPointTipText()
          Tip text for the fill point property
 Color getFillColor()
          get the color for filling the data points
 boolean getFillPoint()
          Get whether the data points should be filled with color
 PaintEvent.PaintMoment getPaintMoment()
          Returns when this paintlet is to be executed.
 int getSize()
          Get the size of the data points
abstract  boolean hasFitLine()
          Whether a regression line has been implemented for this regresion paintlet
protected  void initialize()
          Initializes the members.
 boolean isAntiAliasingEnabled()
          Returns whether anti-aliasing is used.
 void setAntiAliasingEnabled(boolean value)
          Sets whether to use anti-aliasing.
 void setFillColor(Color val)
          Set the color for filling the data points
 void setFillPoint(boolean val)
          Set whether the data points are filled with color
 void setIndex(int val)
          Set the index of the attribute used
 void setLine(boolean val)
          Set whether a regression line is drawn
 void setSize(int val)
          Set the size of the data points
 String sizeTipText()
          Tip text for the data point size property
 
Methods inherited from class adams.gui.visualization.stats.paintlet.AbstractColorPaintlet
colorTipText, 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, performPaint, repaint, setEnabled, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel
 
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, debug, debug, debugLevelTipText, destroy, getDebugLevel, getOptionManager, globalInfo, 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_Index

protected int m_Index
Index of the attribute in the instances


m_RegressionLine

protected boolean m_RegressionLine
Whether to draw a regression line


m_Size

protected int m_Size
Size of the points


m_Fill

protected boolean m_Fill
Whether to fill the data points


m_AxisLeft

protected AxisPanel m_AxisLeft
x axis of the plot


m_AxisBottom

protected AxisPanel m_AxisBottom
y axis of the plot


m_Data

protected double[] m_Data
the sorted data.


m_TransformedY

protected double[] m_TransformedY
Transformed data for the y axis


m_FillColor

protected Color m_FillColor
Color to fill data points


m_AntiAliasingEnabled

protected boolean m_AntiAliasingEnabled
whether anti-aliasing is enabled.

Constructor Detail

AbstractProbabilityPaintlet

public AbstractProbabilityPaintlet()
Method Detail

defineOptions

public void defineOptions()
Adds options to the internal list of options.

Specified by:
defineOptions in interface OptionHandler
Overrides:
defineOptions in class AbstractColorPaintlet

initialize

protected void initialize()
Initializes the members.

Overrides:
initialize in class AbstractPaintlet

setFillColor

public void setFillColor(Color val)
Set the color for filling the data points

Parameters:
val - Color for filling points

getFillColor

public Color getFillColor()
get the color for filling the data points

Returns:
Color for filling the data points

fillColorTipText

public String fillColorTipText()
Tip text for the fill color property

Returns:
String describing the property

setFillPoint

public void setFillPoint(boolean val)
Set whether the data points are filled with color

Parameters:
val - True if data points filled

getFillPoint

public boolean getFillPoint()
Get whether the data points should be filled with color

Returns:
True if filled

fillPointTipText

public String fillPointTipText()
Tip text for the fill point property

Returns:
String describing the property

setSize

public void setSize(int val)
Set the size of the data points

Parameters:
val - Size of the data points in pixels

getSize

public int getSize()
Get the size of the data points

Returns:
Size of the points in pixels

sizeTipText

public String sizeTipText()
Tip text for the data point size property

Returns:

setAntiAliasingEnabled

public void setAntiAliasingEnabled(boolean value)
Sets whether to use anti-aliasing.

Specified by:
setAntiAliasingEnabled in interface AntiAliasingPaintlet
Parameters:
value - if true then anti-aliasing is used

isAntiAliasingEnabled

public boolean isAntiAliasingEnabled()
Returns whether anti-aliasing is used.

Specified by:
isAntiAliasingEnabled in interface AntiAliasingPaintlet
Returns:
true if anti-aliasing is used

antiAliasingEnabledTipText

public String antiAliasingEnabledTipText()
Returns the tip text for this property.

Specified by:
antiAliasingEnabledTipText in interface AntiAliasingPaintlet
Returns:
tip text for this property suitable for displaying in the GUI or for listing the options.

configureAxes

public abstract void configureAxes()
Sets the axes to the correct type for the distribution.


calculateDimensions

public abstract void calculateDimensions()
For calculating the dimensions of the plot area.


getPaintMoment

public PaintEvent.PaintMoment getPaintMoment()
Returns when this paintlet is to be executed.

Specified by:
getPaintMoment in interface Paintlet
Specified by:
getPaintMoment in class AbstractPaintlet
Returns:
when this paintlet is to be executed

setIndex

public void setIndex(int val)
Set the index of the attribute used

Parameters:
val - Attribute index

setLine

public void setLine(boolean val)
Set whether a regression line is drawn

Parameters:
val - True if regression line is to be drawn

hasFitLine

public abstract boolean hasFitLine()
Whether a regression line has been implemented for this regresion paintlet

Returns:
True if regression line implemented


Copyright © 2013 University of Waikato, Hamilton, NZ. All Rights Reserved.