Package adams.flow.transformer

Class WekaEvaluationValuePicker

  • 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 WekaEvaluationValuePicker
extends AbstractTransformer
    Picks a specific value from an evaluation object.

    Input/output:
    - accepts:
       weka.classifiers.Evaluation
    - generates:
       java.lang.Double


    Valid options are: 

    -D (property: debug)
    If set to true, scheme may output additional info to the console.
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: EvaluationValuePicker
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 
    -statistic <ELAPSED_TIME_TRAINING|ELAPSED_TIME_TESTING|USERCPU_TIME_TRAINING|USERCPU_TIME_TESTING|SERIALIZED_MODEL_SIZE|SERIALIZED_TRAIN_SET_SIZE|SERIALIZED_TEST_SET_SIZE|NUMBER_OF_TRAINING_INSTANCES|NUMBER_OF_TESTING_INSTANCES|NUMBER_CORRECT|NUMBER_INCORRECT|NUMBER_UNCLASSIFIED|PERCENT_CORRECT|PERCENT_INCORRECT|PERCENT_UNCLASSIFIED|KAPPA_STATISTIC|MEAN_ABSOLUTE_ERROR|ROOT_MEAN_SQUARED_ERROR|RELATIVE_ABSOLUTE_ERROR|ROOT_RELATIVE_SQUARED_ERROR|CORRELATION_COEFFICIENT|SF_PRIOR_ENTROPY|SF_SCHEME_ENTROPY|SF_ENTROPY_GAIN|SF_MEAN_PRIOR_ENTROPY|SF_MEAN_SCHEME_ENTROPY|SF_MEAN_ENTROPY_GAIN|KB_INFORMATION|KB_MEAN_INFORMATION|KB_RELATIVE_INFORMATION|TRUE_POSITIVE_RATE|NUM_TRUE_POSITIVES|FALSE_POSITIVE_RATE|NUM_FALSE_POSITIVES|TRUE_NEGATIVE_RATE|NUM_TRUE_NEGATIVES|FALSE_NEGATIVE_RATE|NUM_FALSE_NEGATIVES|IR_PRECISION|IR_RECALL|F_MEASURE|AREA_UNDER_ROC> (property: statisticValue)
    The evaluation value to extract.
    default: PERCENT_CORRECT
 
    -index <int> (property: classIndex)
    The class label index (eg used for AUC).
    default: 1
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ClassIndex

        protected WekaLabelIndex m_ClassIndex
        the index of the class label.

    • Constructor Detail

      • WekaEvaluationValuePicker

        public WekaEvaluationValuePicker()

    • Method Detail

      • setStatisticValue

        public void setStatisticValue​(EvaluationStatistic value)
        Sets the value to extract.
        Parameters:
        value - the value

      • getStatisticValue

        public EvaluationStatistic getStatisticValue()
        Returns the value to extract.
        Returns:
        the value

      • statisticValueTipText

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

      • setClassIndex

        public void setClassIndex​(WekaLabelIndex value)
        Sets the class label index (1-based).
        Parameters:
        value - the label index

      • getClassIndex

        public WekaLabelIndex getClassIndex()
        Returns the current class label index (1-based).
        Returns:
        the label index

      • classIndexTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        weka.classifiers.Evaluation.class

      • doExecute

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

      • generates

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