Class RemovePercentage
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.instance.RemovePercentage
- All Implemented Interfaces:
Serializable
,CapabilitiesHandler
,CapabilitiesIgnorer
,CommandlineRunnable
,OptionHandler
,RevisionHandler
,WeightedAttributesHandler
,UnsupervisedFilter
public class RemovePercentage
extends Filter
implements UnsupervisedFilter, OptionHandler, WeightedAttributesHandler
A filter that removes a given percentage of a
dataset.
Valid options are:
-P <percentage> Specifies percentage of instances to select. (default 50)
-V Specifies if inverse of selection is to be output.
- Version:
- $Revision: 14508 $
- Author:
- Richard Kirkby (eibe@cs.waikato.ac.nz), Eibe Frank (eibe@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Signify that this batch of input to the filter is finished.Returns the Capabilities of this filter.boolean
Gets if selection is to be inverted.String[]
Gets the current settings of the filter.double
Gets the percentage of instances to select.Returns the revision string.Returns a string describing this filterboolean
Input an instance for filtering.Returns the tip text for this propertyGets an enumeration describing the available options..static void
Main method for testing this class.Returns the tip text for this propertyboolean
setInputFormat
(Instances instanceInfo) Sets the format of the input instances.void
setInvertSelection
(boolean inverse) Sets if selection is to be inverted.void
setOptions
(String[] options) Parses a given list of options.void
setPercentage
(double percent) Sets the percentage of intances to select.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
-
RemovePercentage
public RemovePercentage()
-
-
Method Details
-
listOptions
Gets 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:-P <percentage> Specifies percentage of instances to select. (default 50)
-V Specifies if inverse of selection is to be output.
- 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
-
percentageTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getPercentage
public double getPercentage()Gets the percentage of instances to select.- Returns:
- the percentage.
-
setPercentage
public void setPercentage(double percent) Sets the percentage of intances to select.- Parameters:
percent
- the percentage- Throws:
IllegalArgumentException
- if percentage out of range
-
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()Gets if selection is to be inverted.- Returns:
- true if the selection is to be inverted
-
setInvertSelection
public void setInvertSelection(boolean inverse) Sets if selection is to be inverted.- Parameters:
inverse
- true if inversion is to be performed
-
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 because outputFormat can be collected immediately
- Throws:
Exception
- if the input format can't be set successfully
-
input
Input an instance for filtering. Ordinarily the instance is processed and made available for output immediately. Some filters require all instances be read before producing output.- Overrides:
input
in classFilter
- Parameters:
instance
- the input instance- Returns:
- true if the filtered instance may now be collected with output().
- Throws:
IllegalStateException
- if no input format has been set.
-
batchFinished
public boolean batchFinished()Signify that this batch of input to the filter is finished. Output() may now be called to retrieve the filtered instances.- Overrides:
batchFinished
in classFilter
- Returns:
- true if there are instances pending output
- Throws:
IllegalStateException
- if no input structure has been defined
-
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
-