com.rapidminer.operator.features.selection
Class AttributeWeightSelection

java.lang.Object
  com.rapidminer.operator.Operator
      com.rapidminer.operator.features.selection.AttributeWeightSelection

All Implemented Interfaces:

ConfigurationListener, PreviewListener, ParameterHandler, LoggingHandler

public class AttributeWeightSelection
extends Operator

This operator selects all attributes which have a weight fulfilling a given condition. For example, only attributes with a weight greater than min_weight should be selected. This operator is also able to select the k attributes with the highest weight.

Author:

Ingo Mierswa, Stefan Rueping

Field Summary

static java.lang.String	PARAMETER_DESELECT_UNKNOWN The parameter name for "Indicates if attributes which weight is unknown should be deselected.
static java.lang.String	PARAMETER_K The parameter name for "Number k of attributes to be selected for weight-relations 'top k' or 'bottom k'.
static java.lang.String	PARAMETER_P The parameter name for "Percentage of attributes to be selected for weight-relations 'top p%' or 'bottom p%'.
static java.lang.String	PARAMETER_USE_ABSOLUTE_WEIGHTS The parameter name for "Indicates if the absolute values of the weights should be used for comparison.
static java.lang.String	PARAMETER_WEIGHT The parameter name for "Use this weight for the selection relation.
static java.lang.String	PARAMETER_WEIGHT_RELATION The parameter name for "Selects only weights which fulfill this relation.

Constructor Summary

AttributeWeightSelection(OperatorDescription description)

Method Summary

IOObject[]	apply() Implement this method in subclasses.
java.lang.Class<?>[]	getInputClasses() Returns the classes that are needed as input.
InputDescription	getInputDescription(java.lang.Class cls) The default implementation returns an input description that consumes the input IOObject without a user parameter.
java.lang.Class<?>[]	getOutputClasses() Returns the classes that are guaranteed to be returned by apply() as additional output.
java.util.List<ParameterType>	getParameterTypes() Returns a list of ParameterTypes describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.Operator

addError, addValue, addWarning, apply, checkDeprecations, checkForStop, checkIO, checkProperties, clearErrorList, cloneOperator, createExperimentTree, createExperimentTree, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, getAddOnlyAdditionalOutput, getApplyCount, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getEncoding, getErrorList, getExperiment, getInnerOperatorsXML, getInput, getInput, getInput, getIOContainerForInApplyLoopBreakpoint, getIODescription, getLog, getName, getOperatorClassName, getOperatorDescription, getParameter, getParameterAsBoolean, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsString, getParameterList, getParameters, getParameterType, getParent, getProcess, getStartTime, getStatus, getUserDescription, getValue, getValues, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isEnabled, isExpanded, isParallel, isParameterSet, log, logError, logNote, logWarning, performAdditionalChecks, processFinished, processStarts, register, registerOperator, remove, rename, resume, setApplyCount, setBreakpoint, setEnabled, setExpanded, setInput, setListParameter, setOperatorParameters, setParameter, setParameters, setParent, setUserDescription, toString, unregisterOperator, writeXML

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_WEIGHT

public static final java.lang.String PARAMETER_WEIGHT

The parameter name for "Use this weight for the selection relation."

See Also:

Constant Field Values

PARAMETER_WEIGHT_RELATION

public static final java.lang.String PARAMETER_WEIGHT_RELATION

The parameter name for "Selects only weights which fulfill this relation."

See Also:

Constant Field Values

PARAMETER_K

public static final java.lang.String PARAMETER_K

The parameter name for "Number k of attributes to be selected for weight-relations 'top k' or 'bottom k'."

See Also:

Constant Field Values

PARAMETER_P

public static final java.lang.String PARAMETER_P

The parameter name for "Percentage of attributes to be selected for weight-relations 'top p%' or 'bottom p%'."

See Also:

Constant Field Values

PARAMETER_DESELECT_UNKNOWN

public static final java.lang.String PARAMETER_DESELECT_UNKNOWN

The parameter name for "Indicates if attributes which weight is unknown should be deselected."

See Also:

Constant Field Values

PARAMETER_USE_ABSOLUTE_WEIGHTS

public static final java.lang.String PARAMETER_USE_ABSOLUTE_WEIGHTS

The parameter name for "Indicates if the absolute values of the weights should be used for comparison."

See Also:

Constant Field Values

Constructor Detail

AttributeWeightSelection

public AttributeWeightSelection(OperatorDescription description)

Method Detail

apply

public IOObject[] apply()
                 throws OperatorException

Description copied from class: Operator

Implement this method in subclasses.

Specified by:

apply in class Operator

Throws:

OperatorException

getInputDescription

public InputDescription getInputDescription(java.lang.Class cls)

Description copied from class: Operator

The default implementation returns an input description that consumes the input IOObject without a user parameter. Subclasses may override this method to allow other input handling behaviors.

Overrides:

getInputDescription in class Operator

getInputClasses

public java.lang.Class<?>[] getInputClasses()

Description copied from class: Operator

Returns the classes that are needed as input. May be null or an empty (no desired input). As default, all delivered input objects are consumed and must be also delivered as output in both Operator.getOutputClasses() and Operator.apply() if this is necessary. This default behavior can be changed by overriding Operator.getInputDescription(Class). Subclasses which implement this method should not make use of parameters since this method is invoked by getParameterTypes(). Therefore, parameters are not fully available at this point of time and this might lead to exceptions. Please use InputDescriptions instead.

Specified by:

getInputClasses in class Operator

getOutputClasses

public java.lang.Class<?>[] getOutputClasses()

Description copied from class: Operator

Returns the classes that are guaranteed to be returned by apply() as additional output. Please note that input objects which should not be consumed must also be defined by this method (e.g. an example set which is changed but not consumed in the case of a preprocessing operator must be defined in both, the methods Operator.getInputClasses() and Operator.getOutputClasses()). The default behavior for input consumation is defined by Operator.getInputDescription(Class) and can be changed by overwriting this method. Objects which are not consumed (defined by changing the implementation in Operator.getInputDescription(Class)) must not be defined as additional output in this method.

May deliver null or an empy array (no additional output is produced or guaranteed). Must return the class array of delivered output objects otherwise.

Specified by:

getOutputClasses in class Operator

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed.

Specified by:

getParameterTypes in interface ParameterHandler

Overrides:

getParameterTypes in class Operator