adams.gui.visualization.stats.paintlet
Class HistogramPaintlet

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.HistogramPaintlet

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, Serializable

public class HistogramPaintlet
extends AbstractColorPaintlet

Paints the histogram

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
 

-fill-bins (property: fillBins)
    Fill the bins with color
 

-fill-color <java.awt.Color> (property: fillColor)
    color for filling the bins
    default: #ff0000
 

Version:

$Revision: 5341 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected AxisPanel	m_AxisBottom x axis of the plot
protected AxisPanel	m_AxisLeft Y axis of the plot
protected double	m_BinWidth Width of each bin in the histogram
protected double[][]	m_Data 2d array containing bin min values and frequency values
protected boolean	m_Fill Whether to fill the bins with color
protected Color	m_FillColor Color to fill the bins with if fill is chosen
protected String	m_Name Name for x axis
protected int	m_NumBins Number of bins in the histogram

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

HistogramPaintlet()

Method Summary

void	defineOptions()
String	fillBinsTipText() Tip text for the fill bins property
String	fillColorTipText() Tip text for the color property
boolean	getFillBins() get whether the bins should be filled with color
Color	getFillColor() Get the color for filling the bins
PaintEvent.PaintMoment	getPaintMoment()
String	globalInfo()
void	performPaint(Graphics g, PaintEvent.PaintMoment moment) The paint routine of the paintlet.
void	setData(double[][] data, double binWidth, String name) Set the data for plotting the histogram
void	setFillBins(boolean val) Set whether the bins should be filled with color
void	setFillColor(Color val) Set the color for filling the bins
void	setNumBins(int val) Set the number of bins in the histogram

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, initialize, 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_AxisLeft

protected AxisPanel m_AxisLeft

Y axis of the plot

m_AxisBottom

protected AxisPanel m_AxisBottom

x axis of the plot

m_NumBins

protected int m_NumBins

Number of bins in the histogram

m_BinWidth

protected double m_BinWidth

Width of each bin in the histogram

m_Data

protected double[][] m_Data

2d array containing bin min values and frequency values

m_Name

protected String m_Name

Name for x axis

m_Fill

protected boolean m_Fill

Whether to fill the bins with color

m_FillColor

protected Color m_FillColor

Color to fill the bins with if fill is chosen

Constructor Detail

HistogramPaintlet

public HistogramPaintlet()

Method Detail

getPaintMoment

public PaintEvent.PaintMoment getPaintMoment()

Specified by:

getPaintMoment in interface Paintlet

Specified by:

getPaintMoment in class AbstractPaintlet

defineOptions

public void defineOptions()

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractColorPaintlet

setFillBins

public void setFillBins(boolean val)

Set whether the bins should be filled with color

Parameters:

val - True if bins filled

getFillBins

public boolean getFillBins()

get whether the bins should be filled with color

Returns:

true if bins filled

fillBinsTipText

public String fillBinsTipText()

Tip text for the fill bins property

Returns:

String describing the property

setFillColor

public void setFillColor(Color val)

Set the color for filling the bins

Parameters:

val - Color for fill

getFillColor

public Color getFillColor()

Get the color for filling the bins

Returns:

Color for fill

fillColorTipText

public String fillColorTipText()

Tip text for the color property

Returns:

Color describing the property

performPaint

public void performPaint(Graphics g,
                         PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

performPaint in interface Paintlet

Specified by:

performPaint in class AbstractPaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted

globalInfo

public String globalInfo()

Specified by:

globalInfo in class AbstractOptionHandler

setNumBins

public void setNumBins(int val)

Set the number of bins in the histogram

Parameters:

val - Number of bins

setData

public void setData(double[][] data,
                    double binWidth,
                    String name)

Set the data for plotting the histogram

Parameters:

data - 2d array containing bin minimum values and frequencies

binWidth - Width of each bin

name - Name for x axis