Class PredictionTrend

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

    public class PredictionTrend
    extends AbstractOutputGeneratorWithSeparateFoldsSupport<ComponentContentPanel>
    implements adams.gui.visualization.core.ColorProviderHandler
    Generates a 'prediction trend' for classifier errors: sorts the predictions on the actual value and plots actual and predicted side-by-side.
    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.ColorProvider m_ColorProvider
      the color provider to use.
      protected adams.gui.visualization.sequence.XYSequencePaintlet m_Paintlet
      the paintlet.
      protected adams.gui.visualization.watermark.Watermark m_Watermark
      the watermark to use.
      • 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
      PredictionTrend()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canGenerateOutput​(ResultItem item)
      Checks whether output can be generated from this item.
      String colorProviderTipText()
      Returns the tip text for this property.
      protected ComponentContentPanel createOutput​(ResultItem item, weka.classifiers.Evaluation eval, int[] originalIndices, adams.data.spreadsheet.SpreadSheet additionalAttributes, adams.core.MessageCollection errors)
      Generates the output for the evaluation.
      void defineOptions()
      Adds options to the internal list of options.
      adams.gui.visualization.core.ColorProvider getColorProvider()
      Returns the color provider for the plots.
      protected adams.gui.visualization.core.ColorProvider getDefaultColorProvider()
      Returns the default color provider to use.
      protected adams.gui.visualization.sequence.XYSequencePaintlet getDefaultPaintlet()
      Returns the default paintlet to use.
      adams.gui.visualization.sequence.XYSequencePaintlet getPaintlet()
      Returns the paintlet to use for the plot.
      String getTitle()
      The title to use for the tab.
      adams.gui.visualization.watermark.Watermark getWatermark()
      Returns the watermark to use.
      String globalInfo()
      Returns a string describing the object.
      String paintletTipText()
      Returns the tip text for this property.
      void setColorProvider​(adams.gui.visualization.core.ColorProvider value)
      Sets the color provider for the plots.
      void setPaintlet​(adams.gui.visualization.sequence.XYSequencePaintlet value)
      Sets the paintlet to use for the plot.
      void setWatermark​(adams.gui.visualization.watermark.Watermark value)
      Sets the watermark to use.
      String watermarkTipText()
      Returns the tip text for this property.
      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString
      • Methods inherited from class adams.core.logging.CustomLoggingLevelObject

        setLoggingLevel
      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf
      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel
    • Field Detail

      • m_Paintlet

        protected adams.gui.visualization.sequence.XYSequencePaintlet m_Paintlet
        the paintlet.
      • m_ColorProvider

        protected adams.gui.visualization.core.ColorProvider m_ColorProvider
        the color provider to use.
      • m_Watermark

        protected adams.gui.visualization.watermark.Watermark m_Watermark
        the watermark to use.
    • Constructor Detail

      • PredictionTrend

        public PredictionTrend()
    • 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
      • getDefaultPaintlet

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

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

        public adams.gui.visualization.sequence.XYSequencePaintlet getPaintlet()
        Returns the paintlet to use for the plot.
        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.
      • getDefaultColorProvider

        protected adams.gui.visualization.core.ColorProvider getDefaultColorProvider()
        Returns the default color provider to use.
        Returns:
        the default
      • setColorProvider

        public void setColorProvider​(adams.gui.visualization.core.ColorProvider value)
        Sets the color provider for the plots.
        Specified by:
        setColorProvider in interface adams.gui.visualization.core.ColorProviderHandler
        Parameters:
        value - the color provider
      • getColorProvider

        public adams.gui.visualization.core.ColorProvider getColorProvider()
        Returns the color provider for the plots.
        Specified by:
        getColorProvider in interface adams.gui.visualization.core.ColorProviderHandler
        Returns:
        the color provider
      • colorProviderTipText

        public String colorProviderTipText()
        Returns the tip text for this property.
        Specified by:
        colorProviderTipText in interface adams.gui.visualization.core.ColorProviderHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setWatermark

        public void setWatermark​(adams.gui.visualization.watermark.Watermark value)
        Sets the watermark to use.
        Parameters:
        value - the watermark
      • getWatermark

        public adams.gui.visualization.watermark.Watermark getWatermark()
        Returns the watermark to use.
        Returns:
        the watermark
      • watermarkTipText

        public String watermarkTipText()
        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

        protected ComponentContentPanel createOutput​(ResultItem item,
                                                     weka.classifiers.Evaluation eval,
                                                     int[] originalIndices,
                                                     adams.data.spreadsheet.SpreadSheet additionalAttributes,
                                                     adams.core.MessageCollection errors)
        Generates the output for the evaluation.
        Specified by:
        createOutput in class AbstractOutputGeneratorWithSeparateFoldsSupport<ComponentContentPanel>
        Parameters:
        item - the item to generate output for
        eval - the evaluation to use as basis
        originalIndices - the original indices to use, can be null
        additionalAttributes - the additional attributes to display, can be null
        errors - for collecting errors
        Returns:
        the generated table, null if failed to generate