Class SamplePlot

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

    public class SamplePlot
    extends AbstractOutputGenerator
    Generates a plot with statistics derived for each sample across the cross-validation runs.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.gui.visualization.core.AxisPanelOptions m_AxisX
      the options for the X axis.
      protected adams.gui.visualization.core.AxisPanelOptions m_AxisY
      the options for the Y axis.
      protected LowerStatistic m_Lower
      the lower value to compute.
      protected adams.gui.visualization.sequence.XYSequencePaintlet m_Paintlet
      the paintlet to use.
      protected adams.flow.sink.sequenceplotter.AbstractErrorPaintlet m_RangePaintlet
      the paintlet to use for the lower/upper statistic.
      protected CenterStatistic m_Statistic
      the statistic to generate.
      protected UpperStatistic m_Upper
      the upper value to compute.
      • 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
      SamplePlot()  
    • Field Detail

      • m_Statistic

        protected CenterStatistic m_Statistic
        the statistic to generate.
      • m_Lower

        protected LowerStatistic m_Lower
        the lower value to compute.
      • m_Upper

        protected UpperStatistic m_Upper
        the upper value to compute.
      • m_Paintlet

        protected adams.gui.visualization.sequence.XYSequencePaintlet m_Paintlet
        the paintlet to use.
      • m_RangePaintlet

        protected adams.flow.sink.sequenceplotter.AbstractErrorPaintlet m_RangePaintlet
        the paintlet to use for the lower/upper statistic.
      • m_AxisX

        protected adams.gui.visualization.core.AxisPanelOptions m_AxisX
        the options for the X axis.
      • m_AxisY

        protected adams.gui.visualization.core.AxisPanelOptions m_AxisY
        the options for the Y axis.
    • Constructor Detail

      • SamplePlot

        public SamplePlot()
    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui
      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.core.option.AbstractOptionHandler
      • setStatistic

        public void setStatistic​(CenterStatistic value)
        Sets the statistic to output.
        Parameters:
        value - the statistic
      • getStatistic

        public CenterStatistic getStatistic()
        Returns the statistic to output.
        Returns:
        the statistic
      • statisticTipText

        public String statisticTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setLower

        public void setLower​(LowerStatistic value)
        Sets the lower value to output.
        Parameters:
        value - the lower value
      • getLower

        public LowerStatistic getLower()
        Returns the lower value to output.
        Returns:
        the lower value
      • lowerTipText

        public String lowerTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setUpper

        public void setUpper​(UpperStatistic value)
        Sets the upper value to output.
        Parameters:
        value - the upper value
      • getUpper

        public UpperStatistic getUpper()
        Returns the upper value to output.
        Returns:
        the upper value
      • upperTipText

        public String upperTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getDefaultPaintlet

        protected adams.gui.visualization.sequence.XYSequencePaintlet getDefaultPaintlet()
        Returns the default paintlet to use.
        Returns:
        the default
      • setPaintlet

        public void setPaintlet​(adams.gui.visualization.sequence.XYSequencePaintlet value)
        Sets the paintlet to use.
        Parameters:
        value - the paintlet
      • getPaintlet

        public adams.gui.visualization.sequence.XYSequencePaintlet getPaintlet()
        Returns the paintlet to use.
        Returns:
        the paintlet
      • paintletTipText

        public String paintletTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getDefaultRangePaintlet

        protected adams.flow.sink.sequenceplotter.AbstractErrorPaintlet getDefaultRangePaintlet()
        Returns the default paintlet to use for the lower/upper statistics.
        Returns:
        the default
      • setRangePaintlet

        public void setRangePaintlet​(adams.flow.sink.sequenceplotter.AbstractErrorPaintlet value)
        Sets the paintlet to use for the lower/upper statistics.
        Parameters:
        value - the paintlet
      • getRangePaintlet

        public adams.flow.sink.sequenceplotter.AbstractErrorPaintlet getRangePaintlet()
        Returns the paintlet to use for the lower/upper statistics.
        Returns:
        the paintlet
      • rangePaintletTipText

        public String rangePaintletTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getDefaultAxisX

        protected adams.gui.visualization.core.AxisPanelOptions getDefaultAxisX()
        Returns the setup for the X axis.
        Returns:
        the setup
      • setAxisX

        public void setAxisX​(adams.gui.visualization.core.AxisPanelOptions value)
        Sets the setup for the X axis.
        Parameters:
        value - the setup
      • getAxisX

        public adams.gui.visualization.core.AxisPanelOptions getAxisX()
        Returns the setup for the X axis.
        Returns:
        the setup
      • axisXTipText

        public String axisXTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • getDefaultAxisY

        protected adams.gui.visualization.core.AxisPanelOptions getDefaultAxisY()
        Returns the setup for the Y axis.
        Returns:
        the setup
      • setAxisY

        public void setAxisY​(adams.gui.visualization.core.AxisPanelOptions value)
        Sets the setup for the Y axis.
        Parameters:
        value - the setup
      • getAxisY

        public adams.gui.visualization.core.AxisPanelOptions getAxisY()
        Returns the setup for the Y axis.
        Returns:
        the setup
      • axisYTipText

        public String axisYTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • createOutput

        public JComponent createOutput​(ResultItem item,
                                       adams.core.MessageCollection errors)
        Generates output from the item.
        Specified by:
        createOutput in class AbstractOutputGenerator<ResultItem>
        Parameters:
        item - the item to generate output for
        errors - for collecting error messages
        Returns:
        the output component, null if failed to generate