Package adams.gui.visualization.stats.histogram

Class 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

    • 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

    • Constructor Detail

      • HistogramOptions

        public HistogramOptions()

    • Method Detail

      • 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