Package adams.flow.transformer

Class WekaInstanceEvaluator

  • 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 WekaInstanceEvaluator
extends AbstractTransformer
    Adds a new attribute to the data being passed through (normally 'evaluation') and sets the value to the evaluation value returned by the chosen evaluator scheme.

    Input/output:
    - accepts:
       weka.core.Instance
    - generates:
       weka.core.Instance


    -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: WekaInstanceEvaluator
 
    -annotation <adams.core.base.BaseText> (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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -evaluator <adams.data.weka.evaluator.AbstractInstanceEvaluator> (property: evaluator)
    The evaluator to use.
    default: adams.data.weka.evaluator.PassThrough
 
    -instances <adams.flow.core.CallableActorReference> (property: instancesActor)
    The name of the callable actor from which to retrieve Instances in case 
    of adams.data.weka.evaluator.AbstractDatasetInstanceEvaluator-derived classes,
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • ATTRIBUTE_NAME

        public static final String ATTRIBUTE_NAME
        the default name of the attribute with the evaluation value.
        See Also:
        Constant Field Values

      • m_InstancesActor

        protected CallableActorReference m_InstancesActor
        the callable actor to get the Instances from in case of AbstractDatasetInstanceEvaluator.

      • m_Header

        protected weka.core.Instances m_Header
        the new header.

      • m_AttributeName

        protected String m_AttributeName
        the attribute name of the evaluation object.

      • m_GlobalSource

        protected CallableSource m_GlobalSource
        the callable actor to use.

      • m_Filter

        protected weka.filters.unsupervised.attribute.Add m_Filter
        the filter that is used for generating the new data format.

    • Constructor Detail

      • WekaInstanceEvaluator

        public WekaInstanceEvaluator()

    • Method Detail

      • reset

        protected void reset()
        Resets the actor.
        Overrides:
        reset in class AbstractActor

      • setEvaluator

        public void setEvaluator​(AbstractInstanceEvaluator value)
        Sets the evaluator to use.
        Parameters:
        value - the evaluator

      • evaluatorTipText

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

      • setInstancesActor

        public void setInstancesActor​(CallableActorReference value)
        Sets the callable actor from which to retrieve Instances in case of AbstractDatasetInstanceEvaluator-derived evaluators.
        Parameters:
        value - the name of the actor

      • getInstancesActor

        public CallableActorReference getInstancesActor()
        Returns the callable actor from which to retrieve Instances in case of AbstractDatasetInstanceEvaluator-derived evaluators.
        Returns:
        the name of the actor

      • instancesActorTipText

        public String instancesActorTipText()
        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.core.Instance.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        weka.core.Instance.class

      • determineAttributeName

        protected String determineAttributeName​(weka.core.Instances data)
        Determines the name of the evaluation attribute.
        Parameters:
        data - the original input data
        Returns:
        the generated name
        See Also:
        m_AttributeName

      • setUpEvaluator

        protected String setUpEvaluator()
        Initializes the evaluator.
        Returns:
        null if everything is fine, otherwise error message
        See Also:
        m_Evaluator

      • generateHeader

        protected String generateHeader​(weka.core.Instance inst)
        Generates the new header for the data.
        Parameters:
        inst - the instance to get the original data format from
        Returns:
        null if everything is fine, otherwise error message
        See Also:
        m_Header, m_Filter

      • doExecute

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