Class RemoveUseless
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.RemoveUseless
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler,WeightedAttributesHandler,WeightedInstancesHandler,UnsupervisedFilter
public class RemoveUseless
extends Filter
implements UnsupervisedFilter, OptionHandler, WeightedInstancesHandler, WeightedAttributesHandler
This filter removes attributes that do not vary at
all or that vary too much. All constant attributes are deleted automatically,
along with any that exceed the maximum percentage of variance parameter. The
maximum variance test is only applied to nominal attributes.
Valid options are:
-M <max variance %> Maximum variance percentage allowed (default 99). Specifically, if (number_of_distinct_values / total_number_of_values * 100) is greater than this value, then the attribute will be removed.
- Version:
- $Revision: 14534 $
- Author:
- Richard Kirkby (rkirkby@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanSignify that this batch of input to the filter is finished.Returns the Capabilities of this filter.doubleGets the maximum variance attributes are allowed to have before they are deleted by the filter.String[]Gets the current settings of the filter.Returns the revision string.Returns a string describing this filterbooleanInput an instance for filtering.Returns an enumeration describing the available options.static voidMain method for testing this class.Returns the tip text for this propertybooleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetMaximumVariancePercentageAllowed(double maxVariance) Sets the maximum variance attributes are allowed to have before they are deleted by the filter.voidsetOptions(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, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
RemoveUseless
public RemoveUseless()
-
-
Method Details
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormatin 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:
batchFinishedin classFilter- Returns:
- true if there are instances pending output
- Throws:
Exception- if no input format defined
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classFilter- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-M <max variance %> Maximum variance percentage allowed (default 99). Specifically, if (number_of_distinct_values / total_number_of_values * 100) is greater than this value, then the attribute will be removed.
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin 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:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin 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
-
maximumVariancePercentageAllowedTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
setMaximumVariancePercentageAllowed
public void setMaximumVariancePercentageAllowed(double maxVariance) Sets the maximum variance attributes are allowed to have before they are deleted by the filter.- Parameters:
maxVariance- the maximum variance allowed, specified as a percentage
-
getMaximumVariancePercentageAllowed
public double getMaximumVariancePercentageAllowed()Gets the maximum variance attributes are allowed to have before they are deleted by the filter.- Returns:
- the maximum variance allowed, specified as a percentage
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classFilter- Returns:
- the revision
-
main
Main method for testing this class.- Parameters:
argv- should contain arguments to the filter: use -h for help
-