Class Predictions

  • 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 Predictions
    extends AbstractOutputGenerator
    Generates statistics for predictions from repeated cross-validation runs.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • 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_NumDecimals

        protected int m_NumDecimals
        the number of decimals to round to.
    • Constructor Detail

      • Predictions

        public Predictions()
    • 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.
      • setNumDecimals

        public void setNumDecimals​(int value)
        Sets the number of decimals to use for numeric values.
        Parameters:
        value - the decimals
      • getNumDecimals

        public int getNumDecimals()
        Returns the number of decimals to use for numeric values.
        Returns:
        the decimals
      • numDecimalsTipText

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