Package adams.gui.visualization.stats.histogram

Class HistogramOptions

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.histogram.HistogramOptions

All Implemented Interfaces:

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

public class HistogramOptions
extends AbstractPlotOptionGroup

Class containing options for the histogram 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
 

-number-bins <int> (property: numberBins)
    Number of bins, used only if frequency axis type chosen
    default: 10
 

-width-bin <double> (property: widthBin)
    Width of each bin, used only if denisty axis type chosen
    default: 0.5
 

-y-axis-type <MANUAL|DENSITY> (property: axisType)
    Axis type for y axis of the histogram
    default: DENSITY
 

-paintlet <adams.gui.visualization.stats.paintlet.HistogramPaintlet> (property: paintlet)
    painlet for plotting the histogram plot
    default: adams.gui.visualization.stats.paintlet.HistogramPaintlet
 

Version:

$Revision$

Author:

msf8

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HistogramOptions.BoxType	Enum for bincalculation type without some of the options

Field Summary

Fields

Modifier and Type	Field	Description
protected HistogramOptions.BoxType	m_BoxType	bin calculation type
protected int	m_NumBins	Number of bins in the histogram used if manual bin calculation type is chosen
protected HistogramPaintlet	m_Val	Paintlet for plotting the histogram
protected double	m_WidthBin	Width of each bin in the histogram, used if density bin calculation type is chosen

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

m_AxisX, m_AxisY, m_Watermark

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

Method Summary

Modifier and Type	Method	Description
String	axisTypeTipText()	Tip Text for the axis Type property
void	defineOptions()	Configures the options.
HistogramOptions.BoxType	getAxisType()	Get the axis type used in bin calculation
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.
int	getNumberBins()	get the number of bins in the histogram
HistogramPaintlet	getPaintlet()	Get the paintlet for plotting the histogram
double	getWidthBin()	Get the width of each bin in histogram
String	numberBinsTipText()	Tip text for the number of bins property
String	paintletTipText()	Tip Text for the paintlet property
void	setAxisType(HistogramOptions.BoxType val)	Set the axis type for bin calculation
void	setNumberBins(int val)	Set the number of bins in the histogram
void	setPaintlet(HistogramPaintlet val)	Set the paintlet for plotting the histogram
void	setWidthBin(double val)	Set the width of each bin in the histogram
String	widthBinTipText()	Tip text for the bin width property

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

axisXTipText, axisYTipText, getAxisX, getAxisY, getDefaultWatermark, getWatermark, setAxisX, setAxisY, setWatermark, watermarkTipText

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_NumBins

protected int m_NumBins

Number of bins in the histogram used if manual bin calculation type is chosen

m_WidthBin

protected double m_WidthBin

Width of each bin in the histogram, used if density bin calculation type is chosen

m_BoxType

protected HistogramOptions.BoxType m_BoxType

bin calculation type

m_Val

protected HistogramPaintlet m_Val

Paintlet for plotting the histogram

Constructor Detail

HistogramOptions

public HistogramOptions()

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

setPaintlet

public void setPaintlet(HistogramPaintlet val)

Set the paintlet for plotting the histogram

Parameters:

val - Paintlet for plotting

getPaintlet

public HistogramPaintlet getPaintlet()

Get the paintlet for plotting the histogram

Returns:

Paintlet for plotting

paintletTipText

public String paintletTipText()

Tip Text for the paintlet property

Returns:

String to describe the property

setAxisType

public void setAxisType(HistogramOptions.BoxType val)

Set the axis type for bin calculation

Parameters:

val - Method of bin calculation

getAxisType

public HistogramOptions.BoxType getAxisType()

Get the axis type used in bin calculation

Returns:

method of bin calculation

axisTypeTipText

public String axisTypeTipText()

Tip Text for the axis Type property

Returns:

String to describe the property

setWidthBin

public void setWidthBin(double val)

Set the width of each bin in the histogram

Parameters:

val - Width of bin

getWidthBin

public double getWidthBin()

Get the width of each bin in histogram

Returns:

Width of each bin

widthBinTipText

public String widthBinTipText()

Tip text for the bin width property

Returns:

String describing the property

setNumberBins

public void setNumberBins(int val)

Set the number of bins in the histogram

Parameters:

val - Number of bins

getNumberBins

public int getNumberBins()

get the number of bins in the histogram

Returns:

Number of bins

numberBinsTipText

public String numberBinsTipText()

Tip text for the number of bins property

Returns:

String describing the property