Package adams.flow.transformer

Class WekaEvaluationSummary

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class WekaEvaluationSummary
extends 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 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 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

      • 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​(BaseText value)
        Sets the comment to output in the summary.
        Parameters:
        value - the comment

      • getComment

        public 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 AbstractActor
        Returns:
        null if everything is fine, otherwise error message