Class RemoveType
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.RemoveType
- All Implemented Interfaces:
Serializable
,CapabilitiesHandler
,CapabilitiesIgnorer
,CommandlineRunnable
,OptionHandler
,RevisionHandler
,WeightedAttributesHandler
,WeightedInstancesHandler
,StreamableFilter
,UnsupervisedFilter
public class RemoveType
extends Filter
implements UnsupervisedFilter, StreamableFilter, OptionHandler, WeightedAttributesHandler, WeightedInstancesHandler
Removes attributes of a given type.
Valid options are:
-T <nominal|numeric|string|date|relational> Attribute type to delete. Valid options are "nominal", "numeric", "string", "date" and "relational". (default "string")
-V Invert matching sense (i.e. only keep specified columns)
- Version:
- $Revision: 15309 $
- Author:
- Richard Kirkby (rkirkby@cs.waikato.ac.nz)
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Tag[]
Tag allowing selection of attribute type to delete -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the tip text for this propertyboolean
Signify that this batch of input to the filter is finished.Gets the attribute type to be deleted by the filter.Returns the Capabilities of this filter.boolean
Get whether the supplied columns are to be removed or keptString[]
Gets the current settings of the filter.Returns the revision string.Returns a string describing this filterboolean
Input an instance for filtering.Returns the tip text for this propertyboolean
Returns whether the output format is ready to be collectedReturns an enumeration describing the available options.static void
Main method for testing this class.int
Returns the number of instances pending outputoutput()
Output an instance after filtering and remove from the output queue.Output an instance after filtering but do not remove from the output queue.void
setAttributeType
(SelectedTag type) Sets the attribute type to be deleted by the filter.boolean
setInputFormat
(Instances instanceInfo) Sets the format of the input instances.void
setInvertSelection
(boolean invert) Set whether selected columns should be removed or kept.void
setOptions
(String[] options) Parses a given list of options.Methods inherited from class weka.filters.Filter
batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Field Details
-
TAGS_ATTRIBUTETYPE
Tag allowing selection of attribute type to delete
-
-
Constructor Details
-
RemoveType
public RemoveType()
-
-
Method Details
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilities
in interfaceCapabilitiesHandler
- Overrides:
getCapabilities
in classFilter
- Returns:
- the capabilities of this object
- See Also:
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormat
in classFilter
- Parameters:
instanceInfo
- an Instances object containing the input instance structure (any instances contained in the object are ignored - only the structure is required).- Returns:
- true if the outputFormat may be collected immediately
- Throws:
Exception
- if the inputFormat can't be set successfully
-
input
Input an instance for filtering. -
batchFinished
Signify that this batch of input to the filter is finished.- Overrides:
batchFinished
in classFilter
- Returns:
- true if there are instances pending output
- Throws:
Exception
- if something goes wrong
-
output
Output an instance after filtering and remove from the output queue. -
outputPeek
Output an instance after filtering but do not remove from the output queue.- Overrides:
outputPeek
in classFilter
- Returns:
- the instance that has most recently been filtered (or null if the queue is empty).
-
numPendingOutput
public int numPendingOutput()Returns the number of instances pending output- Overrides:
numPendingOutput
in classFilter
- Returns:
- the number of instances pending output
-
isOutputFormatDefined
public boolean isOutputFormatDefined()Returns whether the output format is ready to be collected- Overrides:
isOutputFormatDefined
in classFilter
- Returns:
- true if the output format is set
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptions
in interfaceOptionHandler
- Overrides:
listOptions
in classFilter
- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-T <nominal|numeric|string|date|relational> Attribute type to delete. Valid options are "nominal", "numeric", "string", "date" and "relational". (default "string")
-V Invert matching sense (i.e. only keep specified columns)
- Specified by:
setOptions
in interfaceOptionHandler
- Overrides:
setOptions
in classFilter
- Parameters:
options
- the list of options as an array of strings- Throws:
Exception
- if an option is not supported
-
getOptions
Gets the current settings of the filter.- Specified by:
getOptions
in interfaceOptionHandler
- Overrides:
getOptions
in classFilter
- Returns:
- an array of strings suitable for passing to setOptions
-
globalInfo
Returns a string describing this filter- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
attributeTypeTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setAttributeType
Sets the attribute type to be deleted by the filter.- Parameters:
type
- a TAGS_ATTRIBUTETYPE of the new type the filter should delete
-
getAttributeType
Gets the attribute type to be deleted by the filter.- Returns:
- the attribute type as a selected tag TAGS_ATTRIBUTETYPE
-
invertSelectionTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getInvertSelection
public boolean getInvertSelection()Get whether the supplied columns are to be removed or kept- Returns:
- true if the supplied columns will be kept
-
setInvertSelection
public void setInvertSelection(boolean invert) 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:
invert
- the new invert setting
-
getRevision
Returns the revision string.- Specified by:
getRevision
in interfaceRevisionHandler
- Overrides:
getRevision
in classFilter
- Returns:
- the revision
-
main
Main method for testing this class.- Parameters:
argv
- should contain arguments to the filter: use -h for help
-