Package adams.flow.transformer.predictioncheck

Class MinProbability

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable
    public class MinProbability
extends AbstractPredictionCheck
    Ensures that the highest probability on the class distribution is at least the specified value.
    Adds a new boolean evaluation to the container with the name 'minprobability.passed'. 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -minimum <double> (property: minimum)
    The minimum probability (included) that the highest probability in the class
    distribution must achieve.
    default: 0.0
    minimum: 0.0
    maximum: 1.0
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected double m_Minimum
      the minimum probability.
      static String PASSED
      the suffix for the passed flag.

      • 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
      MinProbability()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected String check​(EvaluationContainer cont)
      Hook method for checks.
      void defineOptions()
      Adds options to the internal list of options.
      EvaluationContainer doCheckPrediction​(EvaluationContainer cont)
      Performs the actual checks on the prediction.
      double getMinimum()
      Returns the minimum probability (included) that the highest probability in the class distribution must achieve.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      String minimumTipText()
      Returns the tip text for this property.
      void setMinimum​(double value)
      Sets the minimum probability (included) that the highest probability in the class distribution must achieve.

      • 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 interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_Minimum

        protected double m_Minimum
        the minimum probability.

    • Constructor Detail

      • MinProbability

        public MinProbability()

    • 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

      • setMinimum

        public void setMinimum​(double value)
        Sets the minimum probability (included) that the highest probability in the class distribution must achieve.
        Parameters:
        value - the minimum

      • getMinimum

        public double getMinimum()
        Returns the minimum probability (included) that the highest probability in the class distribution must achieve.
        Returns:
        the minimum

      • minimumTipText

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the object, which can be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class AbstractPredictionCheck
        Returns:
        null if no info available, otherwise short string