weka.knowledgeflow.steps

Class ClassValuePicker

java.lang.Object

weka.knowledgeflow.steps.BaseStep

weka.knowledgeflow.steps.ClassValuePicker

All Implemented Interfaces:

java.io.Serializable, BaseStepExtender, Step

@KFStep(name="ClassValuePicker",
        category="Evaluation",
        toolTipText="Designate which class value is considered the \"positive\" class value (useful for ROC analysis)",
        iconPath="weka/gui/knowledgeflow/icons/ClassValuePicker.gif")
public class ClassValuePicker
extends BaseStep

Step that allows the selection of the class label that is to be considered as the "positive" class when computing threshold curves.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_classIsNominal True if the class is set and is nominal
protected boolean	m_classIsSet True if the class is set in the incoming data
protected java.lang.String	m_classValue Class label after environment variables have been resolved
protected java.lang.String	m_classValueS User specified class label, label index or special identifier (e.g "first"/"last")

Fields inherited from class weka.knowledgeflow.steps.BaseStep

m_stepIsResourceIntensive, m_stepManager, m_stepName

Constructor Summary

Constructors

Constructor and Description
ClassValuePicker()

Method Summary

Modifier and Type	Method and Description
protected Instances	assignClassValue(Instances dataSet) Set the class value to be considered the 'positive' class
java.lang.String	getClassValue() Gets the class value considered to be the "positive" class value.
java.lang.String	getCustomEditorForStep() Return the fully qualified name of a custom editor component (JComponent) to use for editing the properties of the step.
java.util.List<java.lang.String>	getIncomingConnectionTypes() Get a list of incoming connection types that this step can accept.
java.util.List<java.lang.String>	getOutgoingConnectionTypes() Get a list of outgoing connection types that this step can produce.
Instances	outputStructureForConnectionType(java.lang.String connectionName) If possible, get the output structure for the named connection type as a header-only set of instances.
void	processIncoming(Data data) Process an incoming data payload (if the step accepts incoming connections)
void	setClassValue(java.lang.String value) Set the class value considered to be the "positive" class value.
void	stepInit() Initialize the step.

Methods inherited from class weka.knowledgeflow.steps.BaseStep

environmentSubstitute, getDefaultSettings, getInteractiveViewers, getInteractiveViewersImpls, getName, getStepManager, globalInfo, isResourceIntensive, isStopRequested, setName, setStepIsResourceIntensive, setStepManager, setStepMustRunSingleThreaded, start, stepMustRunSingleThreaded, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_classValueS

protected java.lang.String m_classValueS

User specified class label, label index or special identifier (e.g "first"/"last")

m_classValue

protected java.lang.String m_classValue

Class label after environment variables have been resolved

m_classIsSet

protected boolean m_classIsSet

True if the class is set in the incoming data

m_classIsNominal

protected boolean m_classIsNominal

True if the class is set and is nominal

Constructor Detail

ClassValuePicker

public ClassValuePicker()

Method Detail

setClassValue

@OptionMetadata(displayName="Class value",
                description="The class value to consider as the \'positive\' class",
                displayOrder=1)
public void setClassValue(java.lang.String value)

Set the class value considered to be the "positive" class value.

Parameters:

value - the class value index to use

getClassValue

public java.lang.String getClassValue()

Gets the class value considered to be the "positive" class value.

Returns:

the class value index

stepInit

public void stepInit()
              throws WekaException

Initialize the step.

Throws:

WekaException - if a problem occurs during initialization

processIncoming

public void processIncoming(Data data)
                     throws WekaException

Process an incoming data payload (if the step accepts incoming connections)

Specified by:

processIncoming in interface BaseStepExtender

Specified by:

processIncoming in interface Step

Overrides:

processIncoming in class BaseStep

Parameters:

data - the payload to process

Throws:

WekaException - if a problem occurs

assignClassValue

protected Instances assignClassValue(Instances dataSet)
                              throws WekaException

Set the class value to be considered the 'positive' class

Parameters:

dataSet - the dataset to assign the class value for

Returns:

the altered dataset

Throws:

WekaException - if a problem occurs

getIncomingConnectionTypes

public java.util.List<java.lang.String> getIncomingConnectionTypes()

Get a list of incoming connection types that this step can accept. Ideally (and if appropriate), this should take into account the state of the step and any existing incoming connections. E.g. a step might be able to accept one (and only one) incoming batch data connection.

Returns:

a list of incoming connections that this step can accept given its current state

getOutgoingConnectionTypes

public java.util.List<java.lang.String> getOutgoingConnectionTypes()

Get a list of outgoing connection types that this step can produce. Ideally (and if appropriate), this should take into account the state of the step and the incoming connections. E.g. depending on what incoming connection is present, a step might be able to produce a trainingSet output, a testSet output or neither, but not both.

Returns:

a list of outgoing connections that this step can produce

outputStructureForConnectionType

public Instances outputStructureForConnectionType(java.lang.String connectionName)
                                           throws WekaException

If possible, get the output structure for the named connection type as a header-only set of instances. Can return null if the specified connection type is not representable as Instances or cannot be determined at present.

Specified by:

outputStructureForConnectionType in interface Step

Overrides:

outputStructureForConnectionType in class BaseStep

Parameters:

connectionName - the name of the connection type to get the output structure for

Returns:

the output structure as a header-only Instances object

Throws:

WekaException - if a problem occurs

getCustomEditorForStep

public java.lang.String getCustomEditorForStep()

Return the fully qualified name of a custom editor component (JComponent) to use for editing the properties of the step. This method can return null, in which case the system will dynamically generate an editor using the GenericObjectEditor

Specified by:

getCustomEditorForStep in interface Step

Overrides:

getCustomEditorForStep in class BaseStep

Returns:

the fully qualified name of a step editor component