Class RemoveRange
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.instance.RemoveRange
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,RevisionHandler,WeightedAttributesHandler,WeightedInstancesHandler,UnsupervisedFilter
public class RemoveRange
extends Filter
implements UnsupervisedFilter, OptionHandler, WeightedAttributesHandler, WeightedInstancesHandler
A filter that removes a given range of instances of
a dataset.
Valid options are:
-R <inst1,inst2-inst4,...> Specifies list of instances to select. First and last are valid indexes. (required)
-V Specifies if inverse of selection is to be output.
- Version:
- $Revision: 14534 $
- Author:
- Eibe Frank (eibe@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.Gets ranges of instances selected.booleanGets if selection is to be inverted.String[]Gets the current settings of the filter.Returns the revision string.Returns a string describing this filterbooleanInput an instance for filtering.Returns the tip text for this propertyReturns the tip text for this propertyReturns an enumeration describing the available options.static voidMain method for testing this class.booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetInstancesIndices(String rangeList) Sets the ranges of instances to be selected.voidsetInvertSelection(boolean inverse) Sets if selection is to be inverted.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
-
RemoveRange
public RemoveRange()
-
-
Method Details
-
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:-R <inst1,inst2-inst4,...> Specifies list of instances to select. First and last are valid indexes. (required)
-V Specifies if inverse of selection is to be output.
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classFilter- Parameters:
options- the list of options as an array of string.s- 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 GUI.
-
instancesIndicesTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getInstancesIndices
Gets ranges of instances selected.- Returns:
- a string containing a comma-separated list of ranges
-
setInstancesIndices
Sets the ranges of instances to be selected. If provided string is null, ranges won't be used for selecting instances.- Parameters:
rangeList- a string representing the list of instances. eg: first-3,5,6-last- Throws:
IllegalArgumentException- if an invalid range list is supplied
-
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:
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 because outputFormat can be collected immediately
- Throws:
Exception- if the input format can't be set successfully
-
input
Input an instance for filtering. Filter requires all training instances be read before producing output.- Overrides:
inputin classFilter- Parameters:
instance- the input instance- Returns:
- true if the filtered instance may now be collected with output().
- Throws:
IllegalStateException- if no input structure has been defined
-
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:
batchFinishedin 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:
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
-