Package adams.flow.transformer

Class WekaEvaluationSummary

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, 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 WekaEvaluationSummary
extends adams.flow.transformer.AbstractTransformer
    Generates a summary string of the weka.classifiers.Evaluation objects that it receives.

    Input/output:
    - accepts:
       weka.classifiers.Evaluation
       adams.flow.container.WekaEvaluationContainer
    - generates:
       java.lang.String


    Container information:
    - adams.flow.container.WekaEvaluationContainer: Evaluation, Model, Prediction output, Original indices, Test data 

    -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: WekaEvaluationSummary
 
    -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
 
    -relation <boolean> (property: outputRelationName)
    If set to true, then the relation name of the dataset is output as well.
    default: false
 
    -confusion-matrix <boolean> (property: confusionMatrix)
    If set to true, then the confusion matrix will be output as well.
    default: false
 
    -complexity-stats <boolean> (property: complexityStatistics)
    If set to true, then the complexity statistics will be output as well.
    default: false
 
    -class-details <boolean> (property: classDetails)
    If set to true, then the class details are output as well.
    default: false
 
    -comment <adams.core.base.BaseText> (property: comment)
    An optional comment to output in the summary.
    default:
 
    -title-summary <java.lang.String> (property: titleSummary)
    The title to use, default one is used when left empty.
    default:
 
    -title-matrix <java.lang.String> (property: titleMatrix)
    The title to use for the confusion matrix, default one is used when left
    empty.
    default:
 
    -title-class-details <java.lang.String> (property: titleClassDetails)
    The title to use for the class details, default one is used when left empty.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean m_ClassDetails
      whether to print the class details as well.
      protected adams.core.base.BaseText m_Comment
      an optional comment to output.
      protected boolean m_ComplexityStatistics
      whether to print the complexity statistics as well.
      protected boolean m_ConfusionMatrix
      whether to print the confusion matrix as well.
      protected boolean m_OutputRelationName
      whether to print the relation name of the dataset a well.
      protected String m_TitleClassDetails
      the title to use for the summary.
      protected String m_TitleMatrix
      the title to use for the matrix.
      protected String m_TitleSummary
      the title to use for the summary.

      • 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 classDetailsTipText()
      Returns the tip text for this property.
      String commentTipText()
      Returns the tip text for this property.
      String complexityStatisticsTipText()
      Returns the tip text for this property.
      String confusionMatrixTipText()
      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.
      boolean getClassDetails()
      Returns whether the class details are output as well.
      adams.core.base.BaseText getComment()
      Returns the comment to output in the summary.
      boolean getComplexityStatistics()
      Returns whether the complexity stats are output as well.
      boolean getConfusionMatrix()
      Returns whether to output the confusion matrix as well.
      boolean getOutputRelationName()
      Returns whether the relation name is output as well.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String getTitleClassDetails()
      Returns the title to use for the class details.
      String getTitleMatrix()
      Returns the title to use for the confusion matrix.
      String getTitleSummary()
      Returns the title to use for the summary.
      String globalInfo()
      Returns a string describing the object.
      String outputRelationNameTipText()
      Returns the tip text for this property.
      void setClassDetails​(boolean value)
      Sets whether the class details are output as well.
      void setComment​(adams.core.base.BaseText value)
      Sets the comment to output in the summary.
      void setComplexityStatistics​(boolean value)
      Sets whether to output complexity stats as well.
      void setConfusionMatrix​(boolean value)
      Sets whether to output the confusion matrix as well.
      void setOutputRelationName​(boolean value)
      Sets whether to output the relation name as well.
      void setTitleClassDetails​(String value)
      Sets the title to use for the class details.
      void setTitleMatrix​(String value)
      Sets the title to use for the confusion matrix.
      void setTitleSummary​(String value)
      Sets the title to use for the summary.
      String titleClassDetailsTipText()
      Returns the tip text for this property.
      String titleMatrixTipText()
      Returns the tip text for this property.
      String titleSummaryTipText()
      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_OutputRelationName

        protected boolean m_OutputRelationName
        whether to print the relation name of the dataset a well.

      • m_ConfusionMatrix

        protected boolean m_ConfusionMatrix
        whether to print the confusion matrix as well.

      • m_ComplexityStatistics

        protected boolean m_ComplexityStatistics
        whether to print the complexity statistics as well.

      • m_ClassDetails

        protected boolean m_ClassDetails
        whether to print the class details as well.

      • m_Comment

        protected adams.core.base.BaseText m_Comment
        an optional comment to output.

      • m_TitleSummary

        protected String m_TitleSummary
        the title to use for the summary.

      • m_TitleMatrix

        protected String m_TitleMatrix
        the title to use for the matrix.

      • m_TitleClassDetails

        protected String m_TitleClassDetails
        the title to use for the summary.

    • Constructor Detail

      • WekaEvaluationSummary

        public WekaEvaluationSummary()

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

      • 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.
        Returns:
        weka.classifiers.Evaluation.class, adams.flow.container.WekaEvaluationContainer.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        java.lang.String.class

      • setTitleSummary

        public void setTitleSummary​(String value)
        Sets the title to use for the summary.
        Parameters:
        value - the title

      • getTitleSummary

        public String getTitleSummary()
        Returns the title to use for the summary.
        Returns:
        the title

      • titleSummaryTipText

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

      • setTitleMatrix

        public void setTitleMatrix​(String value)
        Sets the title to use for the confusion matrix.
        Parameters:
        value - the title

      • getTitleMatrix

        public String getTitleMatrix()
        Returns the title to use for the confusion matrix.
        Returns:
        the title

      • titleMatrixTipText

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

      • setTitleClassDetails

        public void setTitleClassDetails​(String value)
        Sets the title to use for the class details.
        Parameters:
        value - the title

      • getTitleClassDetails

        public String getTitleClassDetails()
        Returns the title to use for the class details.
        Returns:
        the title

      • titleClassDetailsTipText

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

      • setOutputRelationName

        public void setOutputRelationName​(boolean value)
        Sets whether to output the relation name as well.
        Parameters:
        value - if true then the relation name is output as well

      • getOutputRelationName

        public boolean getOutputRelationName()
        Returns whether the relation name is output as well.
        Returns:
        true if the relation name is output as well

      • outputRelationNameTipText

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

      • setConfusionMatrix

        public void setConfusionMatrix​(boolean value)
        Sets whether to output the confusion matrix as well.
        Parameters:
        value - if true then the confusion matrix will be output as well

      • getConfusionMatrix

        public boolean getConfusionMatrix()
        Returns whether to output the confusion matrix as well.
        Returns:
        true if the confusion matrix stats are output as well

      • confusionMatrixTipText

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

      • setComplexityStatistics

        public void setComplexityStatistics​(boolean value)
        Sets whether to output complexity stats as well.
        Parameters:
        value - if true then the complexity stats will be output as well

      • getComplexityStatistics

        public boolean getComplexityStatistics()
        Returns whether the complexity stats are output as well.
        Returns:
        true if the complexity stats are output as well

      • complexityStatisticsTipText

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

      • setClassDetails

        public void setClassDetails​(boolean value)
        Sets whether the class details are output as well.
        Parameters:
        value - if true then the class details are output as well

      • getClassDetails

        public boolean getClassDetails()
        Returns whether the class details are output as well.
        Returns:
        true if the class details are output as well

      • classDetailsTipText

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

      • setComment

        public void setComment​(adams.core.base.BaseText value)
        Sets the comment to output in the summary.
        Parameters:
        value - the comment

      • getComment

        public adams.core.base.BaseText getComment()
        Returns the comment to output in the summary.
        Returns:
        the comment

      • commentTipText

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

      • 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