weka.filters.unsupervised.attribute

Class RemoveByName

java.lang.Object

weka.filters.Filter

weka.filters.SimpleFilter

weka.filters.SimpleStreamFilter

weka.filters.unsupervised.attribute.RemoveByName

All Implemented Interfaces:

java.io.Serializable, CapabilitiesHandler, CapabilitiesIgnorer, CommandlineRunnable, OptionHandler, RevisionHandler, WeightedAttributesHandler, WeightedInstancesHandler, StreamableFilter

public class RemoveByName
extends SimpleStreamFilter
implements WeightedInstancesHandler, WeightedAttributesHandler

Removes attributes based on a regular expression matched against their names.

Valid options are:

 -D
  Turns on output of debugging information.
 

 -E <regular expression>
  The regular expression to match the attribute names against.
  (default: ^.*id$)
 

 -V
  Flag for inverting the matching sense. If set, attributes are kept
  instead of deleted.
  (default: off)
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_EXPRESSION the default expression.
protected java.lang.String	m_Expression the regular expression for selecting the attributes by name.
protected boolean	m_InvertSelection whether to invert the matching sense.
protected Remove	m_Remove the Remove filter used internally for removing the attributes.

Fields inherited from class weka.filters.Filter

m_Debug, m_DoNotCheckCapabilities, m_FirstBatchDone, m_InputRelAtts, m_InputStringAtts, m_NewBatch, m_OutputRelAtts, m_OutputStringAtts

Constructor Summary

Constructors

Constructor and Description
RemoveByName()

Method Summary

Modifier and Type	Method and Description
protected Instances	determineOutputFormat(Instances inputFormat) Determines the output format based on the input format and returns this.
java.lang.String	expressionTipText() Returns the tip text for this property.
Capabilities	getCapabilities() Returns the Capabilities of this filter.
java.lang.String	getExpression() Returns the regular expression in use.
boolean	getInvertSelection() Get whether the supplied columns are to be removed or kept.
java.lang.String[]	getOptions() returns the options of the current setup.
java.lang.String	getRevision() Returns the revision string.
java.lang.String	globalInfo() Returns a string describing this classifier.
java.lang.String	invertSelectionTipText() Returns the tip text for this property.
java.util.Enumeration<Option>	listOptions() Gets an enumeration describing the available options.
static void	main(java.lang.String[] args) runs the filter with the given arguments.
protected Instance	process(Instance instance) processes the given instance (may change the provided instance) and returns the modified version.
void	setExpression(java.lang.String value) Sets the regular expression to match the attribute names against.
void	setInvertSelection(boolean value) Set whether selected columns should be removed or kept.
void	setOptions(java.lang.String[] options) Parses the options for this object.

Methods inherited from class weka.filters.SimpleStreamFilter

batchFinished, hasImmediateOutputFormat, input, preprocess, process

Methods inherited from class weka.filters.SimpleFilter

reset, setInputFormat

Methods inherited from class weka.filters.Filter

batchFilterFile, bufferInput, copyValues, copyValues, debugTipText, doNotCheckCapabilitiesTipText, filterFile, flushInput, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getInputFormat, getOutputFormat, initInputLocators, initOutputLocators, inputFormatPeek, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputFormatPeek, outputPeek, postExecution, preExecution, push, push, resetQueue, run, runFilter, setDebug, setDoNotCheckCapabilities, setOutputFormat, testInputFormat, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EXPRESSION

public static final java.lang.String DEFAULT_EXPRESSION

the default expression.

See Also:

Constant Field Values

m_Expression

protected java.lang.String m_Expression

the regular expression for selecting the attributes by name.

m_InvertSelection

protected boolean m_InvertSelection

whether to invert the matching sense.

m_Remove

protected Remove m_Remove

the Remove filter used internally for removing the attributes.

Constructor Detail

RemoveByName

public RemoveByName()

Method Detail

globalInfo

public java.lang.String globalInfo()

Returns a string describing this classifier.

Specified by:

globalInfo in class SimpleFilter

Returns:

a description of the classifier suitable for displaying in the explorer/experimenter gui

listOptions

public java.util.Enumeration<Option> listOptions()

Gets an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Overrides:

listOptions in class Filter

Returns:

an enumeration of all the available options.

getOptions

public java.lang.String[] getOptions()

returns the options of the current setup.

Specified by:

getOptions in interface OptionHandler

Overrides:

getOptions in class Filter

Returns:

the current options

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses the options for this object.

Valid options are:

 -D
  Turns on output of debugging information.
 

 -E <regular expression>
  The regular expression to match the attribute names against.
  (default: ^.*id$)
 

 -V
  Flag for inverting the matching sense. If set, attributes are kept
  instead of deleted.
  (default: off)
 

Specified by:

setOptions in interface OptionHandler

Overrides:

setOptions in class Filter

Parameters:

options - the options to use

Throws:

java.lang.Exception - if the option setting fails

setExpression

public void setExpression(java.lang.String value)

Sets the regular expression to match the attribute names against.

Parameters:

value - the regular expression

getExpression

public java.lang.String getExpression()

Returns the regular expression in use.

Returns:

the regular expression

expressionTipText

public java.lang.String expressionTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

setInvertSelection

public void setInvertSelection(boolean value)

Set whether selected columns should be removed or kept. If true the selected columns are kept and unselected columns are deleted. If false selected columns are deleted and unselected columns are kept.

Parameters:

value - the new invert setting

getInvertSelection

public boolean getInvertSelection()

Get whether the supplied columns are to be removed or kept.

Returns:

true if the supplied columns will be kept

invertSelectionTipText

public java.lang.String invertSelectionTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

determineOutputFormat

protected Instances determineOutputFormat(Instances inputFormat)
                                   throws java.lang.Exception

Determines the output format based on the input format and returns this. In case the output format cannot be returned immediately, i.e., immediateOutputFormat() returns false, then this method will be called from batchFinished().

Specified by:

determineOutputFormat in class SimpleStreamFilter

Parameters:

inputFormat - the input format to base the output format on

Returns:

the output format

Throws:

java.lang.Exception - in case the determination goes wrong

See Also:

SimpleStreamFilter.hasImmediateOutputFormat(), SimpleStreamFilter.batchFinished(), SimpleStreamFilter.preprocess(Instances)

getCapabilities

public Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface CapabilitiesHandler

Overrides:

getCapabilities in class Filter

Returns:

the capabilities of this object

See Also:

Capabilities

process

protected Instance process(Instance instance)
                    throws java.lang.Exception

processes the given instance (may change the provided instance) and returns the modified version.

Specified by:

process in class SimpleStreamFilter

Parameters:

instance - the instance to process

Returns:

the modified data

Throws:

java.lang.Exception - in case the processing goes wrong

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface RevisionHandler

Overrides:

getRevision in class Filter

Returns:

the revision

main

public static void main(java.lang.String[] args)

runs the filter with the given arguments.

Parameters:

args - the commandline arguments