Package adams.flow.transformer

Class WekaSpreadSheetToPredictions

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.ClassCrossReference, adams.core.CleanUpHandler, adams.core.CrossReference, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.core.OutputProducer, Serializable, Comparable
    public class WekaSpreadSheetToPredictions
extends adams.flow.transformer.AbstractTransformer
implements adams.core.ClassCrossReference
    Turns the predictions stored in the incoming spreadsheet (actual and predicted) into a Weka weka.classifiers.Evaluation object.
    For recreating the predictions of a nominal class, the class distributions must be present in the spreadsheet as well.

    See also:
    adams.flow.transformer.WekaPredictionsToSpreadSheet

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
    - generates:
       weka.classifiers.Evaluation


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: WekaSpreadSheetToPredictions
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -actual <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: actual)
    The column with the actual values.
    default: Actual
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -predicted <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: predicted)
    The column with the predicted values.
    default: Predicted
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -class-distribution <adams.data.spreadsheet.SpreadSheetUnorderedColumnRange> (property: classDistribution)
    The columns containing the class distribution (nominal class).
    default:
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -column-names-as-class-labels <boolean> (property: useColumnNamesAsClassLabels)
    If enabled, the names of the class distribution columns are used as labels
    in the fake evaluation; automatically removes the surrounding 'Distribution
    (...)'.
    default: false
 
    -weight <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: weight)
    The (optional) column with the weights of the instances; 1.0 is assumed
    by default.
    default:
    example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
 
    -sort-labels <boolean> (property: sortLabels)
    If enabled, the labels get sorted with the specified comparator.
    default: false
 
    -comparator <java.util.Comparator> (property: comparator)
    The comparator to use; must implement java.util.Comparator and java.io.Serializable
    default: adams.core.DefaultCompare
 
    -reverse <boolean> (property: reverse)
    If enabled, the sorting order gets reversed.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_Actual
      the column with the actual values.
      protected adams.data.spreadsheet.SpreadSheetUnorderedColumnRange m_ClassDistribution
      the columns with the class distributions.
      protected Comparator m_Comparator
      the comparator to use.
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_Predicted
      the column with the predicted values.
      protected boolean m_Reverse
      whether to reverse the sorting.
      protected boolean m_SortLabels
      whether to sort the labels.
      protected boolean m_UseColumnNamesAsClassLabels
      whether to use the column name as class labels.
      protected adams.data.spreadsheet.SpreadSheetColumnIndex m_Weight
      the (optional) column with the instance weights.

      • Fields inherited from class adams.flow.transformer.AbstractTransformer

        BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the class that the consumer accepts.
      String actualTipText()
      Returns the tip text for this property.
      String classDistributionTipText()
      Returns the tip text for this property.
      String comparatorTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      Class[] generates()
      Returns the class of objects that it generates.
      adams.data.spreadsheet.SpreadSheetColumnIndex getActual()
      Returns the column with the actual values.
      Class[] getClassCrossReferences()
      Returns the cross-referenced classes.
      adams.data.spreadsheet.SpreadSheetUnorderedColumnRange getClassDistribution()
      Returns the columns with the class distribution (nominal class).
      Comparator getComparator()
      Returns the comparator to use.
      adams.data.spreadsheet.SpreadSheetColumnIndex getPredicted()
      Returns the column with the predicted values.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      boolean getReverse()
      Returns whether to reverse the sorting.
      boolean getSortLabels()
      Returns whether to store the labels with the specified comparator.
      boolean getUseColumnNamesAsClassLabels()
      Returns whether to use the names of the class distribution columns as labels in the fake evaluation.
      adams.data.spreadsheet.SpreadSheetColumnIndex getWeight()
      Returns the (optional) column with the instance weight values.
      String globalInfo()
      Returns a string describing the object.
      String predictedTipText()
      Returns the tip text for this property.
      String reverseTipText()
      Returns the tip text for this property.
      void setActual​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the column with the actual values.
      void setClassDistribution​(adams.data.spreadsheet.SpreadSheetUnorderedColumnRange value)
      Sets the columns with the class distribution (nominal class).
      void setComparator​(Comparator value)
      Sets the comparator to use.
      void setPredicted​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the column with the predicted values.
      void setReverse​(boolean value)
      Sets whether to reverse the sorting.
      void setSortLabels​(boolean value)
      Sets whether to sort the labels with the specified comparator.
      void setUseColumnNamesAsClassLabels​(boolean value)
      Sets whether to use the names of the class distribution columns as labels in the fake evaluation.
      void setWeight​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
      Sets the (optional) column with the instance weight values.
      String sortLabelsTipText()
      Returns the tip text for this property.
      String useColumnNamesAsClassLabelsTipText()
      Returns the tip text for this property.
      String weightTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.transformer.AbstractTransformer

        backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, pruneBackup, reset, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

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

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel, setLoggingLevel

      • Methods inherited from interface adams.core.logging.LoggingSupporter

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • m_Actual

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_Actual
        the column with the actual values.

      • m_Predicted

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_Predicted
        the column with the predicted values.

      • m_ClassDistribution

        protected adams.data.spreadsheet.SpreadSheetUnorderedColumnRange m_ClassDistribution
        the columns with the class distributions.

      • m_UseColumnNamesAsClassLabels

        protected boolean m_UseColumnNamesAsClassLabels
        whether to use the column name as class labels.

      • m_Weight

        protected adams.data.spreadsheet.SpreadSheetColumnIndex m_Weight
        the (optional) column with the instance weights.

      • m_SortLabels

        protected boolean m_SortLabels
        whether to sort the labels.

      • m_Comparator

        protected Comparator m_Comparator
        the comparator to use.

      • m_Reverse

        protected boolean m_Reverse
        whether to reverse the sorting.

    • Constructor Detail

      • WekaSpreadSheetToPredictions

        public WekaSpreadSheetToPredictions()

    • 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

      • getClassCrossReferences

        public Class[] getClassCrossReferences()
        Returns the cross-referenced classes.
        Specified by:
        getClassCrossReferences in interface adams.core.ClassCrossReference
        Returns:
        the classes

      • 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.flow.core.AbstractActor

      • setActual

        public void setActual​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the column with the actual values.
        Parameters:
        value - the column

      • getActual

        public adams.data.spreadsheet.SpreadSheetColumnIndex getActual()
        Returns the column with the actual values.
        Returns:
        the range

      • actualTipText

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

      • setPredicted

        public void setPredicted​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the column with the predicted values.
        Parameters:
        value - the column

      • getPredicted

        public adams.data.spreadsheet.SpreadSheetColumnIndex getPredicted()
        Returns the column with the predicted values.
        Returns:
        the range

      • predictedTipText

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

      • setClassDistribution

        public void setClassDistribution​(adams.data.spreadsheet.SpreadSheetUnorderedColumnRange value)
        Sets the columns with the class distribution (nominal class).
        Parameters:
        value - the range

      • getClassDistribution

        public adams.data.spreadsheet.SpreadSheetUnorderedColumnRange getClassDistribution()
        Returns the columns with the class distribution (nominal class).
        Returns:
        the range

      • classDistributionTipText

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

      • setUseColumnNamesAsClassLabels

        public void setUseColumnNamesAsClassLabels​(boolean value)
        Sets whether to use the names of the class distribution columns as labels in the fake evaluation.
        Parameters:
        value - true if to use column names

      • getUseColumnNamesAsClassLabels

        public boolean getUseColumnNamesAsClassLabels()
        Returns whether to use the names of the class distribution columns as labels in the fake evaluation.
        Returns:
        true if to use column names

      • useColumnNamesAsClassLabelsTipText

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

      • setWeight

        public void setWeight​(adams.data.spreadsheet.SpreadSheetColumnIndex value)
        Sets the (optional) column with the instance weight values.
        Parameters:
        value - the column

      • getWeight

        public adams.data.spreadsheet.SpreadSheetColumnIndex getWeight()
        Returns the (optional) column with the instance weight values.
        Returns:
        the column

      • weightTipText

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

      • setSortLabels

        public void setSortLabels​(boolean value)
        Sets whether to sort the labels with the specified comparator.
        Parameters:
        value - true if to sort

      • getSortLabels

        public boolean getSortLabels()
        Returns whether to store the labels with the specified comparator.
        Returns:
        true if to sort

      • sortLabelsTipText

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

      • setComparator

        public void setComparator​(Comparator value)
        Sets the comparator to use.
        Parameters:
        value - the comparator

      • getComparator

        public Comparator getComparator()
        Returns the comparator to use.
        Returns:
        the comparator

      • comparatorTipText

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

      • setReverse

        public void setReverse​(boolean value)
        Sets whether to reverse the sorting.
        Parameters:
        value - true if to reverse

      • getReverse

        public boolean getReverse()
        Returns whether to reverse the sorting.
        Returns:
        true if to reverse

      • reverseTipText

        public String reverseTipText()
        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 actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface adams.flow.core.InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface adams.flow.core.OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message