Class WekaForecastContainerToArray

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable

    public class WekaForecastContainerToArray
    extends AbstractConversion
    Turns a series of predictions of a adams.flow.container.WekaForecastContainer container into a Double array.

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
     
    -index <adams.core.Index> (property: index)
        The index of the timeseries to extract from the container.
        default: first
        example: An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last
     
    -prediction-range <adams.core.Range> (property: predictionRange)
        The range of predictions to convert into an array.
        default: first-last
        example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
     
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form
    • Field Detail

      • m_Index

        protected Index m_Index
        the index of the timeseries to extract from the container.
      • m_PredictionRange

        protected Range m_PredictionRange
        the range of predictions to turn into an array.
    • Constructor Detail

      • WekaForecastContainerToArray

        public WekaForecastContainerToArray()
    • Method Detail

      • setIndex

        public void setIndex​(Index value)
        Sets the index of the timeseries to extract from the container.
        Parameters:
        value - the index
      • getIndex

        public Index getIndex()
        Returns the index of the timeseries to extract from the container.
        Returns:
        the index
      • indexTipText

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

        public void setPredictionRange​(Range value)
        Sets the range of predictions to turn into an array.
        Parameters:
        value - the range
      • getPredictionRange

        public Range getPredictionRange()
        Returns the range of predictions to turn into an array.
        Returns:
        the range
      • predictionRangeTipText

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