weka.filters.unsupervised.instance
Class RemoveRange

java.lang.Object
  extended by weka.filters.Filter
      extended by weka.filters.unsupervised.instance.RemoveRange
All Implemented Interfaces:
java.io.Serializable, CapabilitiesHandler, OptionHandler, UnsupervisedFilter

public class RemoveRange
extends Filter
implements UnsupervisedFilter, OptionHandler

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: 1.7 $
Author:
Eibe Frank (eibe@cs.waikato.ac.nz)
See Also:
Serialized Form

Constructor Summary
RemoveRange()
           
 
Method Summary
 boolean batchFinished()
          Signify that this batch of input to the filter is finished.
 Capabilities getCapabilities()
          Returns the Capabilities of this filter.
 java.lang.String getInstancesIndices()
          Gets ranges of instances selected.
 boolean getInvertSelection()
          Gets if selection is to be inverted.
 java.lang.String[] getOptions()
          Gets the current settings of the filter.
 java.lang.String globalInfo()
          Returns a string describing this filter
 boolean input(Instance instance)
          Input an instance for filtering.
 java.lang.String instancesIndicesTipText()
          Returns the tip text for this property
 java.lang.String invertSelectionTipText()
          Returns the tip text for this property
 java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
static void main(java.lang.String[] argv)
          Main method for testing this class.
 boolean setInputFormat(Instances instanceInfo)
          Sets the format of the input instances.
 void setInstancesIndices(java.lang.String rangeList)
          Sets the ranges of instances to be selected.
 void setInvertSelection(boolean inverse)
          Sets if selection is to be inverted.
 void setOptions(java.lang.String[] options)
          Parses a given list of options.
 
Methods inherited from class weka.filters.Filter
batchFilterFile, filterFile, getCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RemoveRange

public RemoveRange()
Method Detail

listOptions

public java.util.Enumeration listOptions()
Returns an enumeration describing the available options.

Specified by:
listOptions in interface OptionHandler
Returns:
an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
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:
setOptions in interface OptionHandler
Parameters:
options - the list of options as an array of string.s
Throws:
java.lang.Exception - if an option is not supported.

getOptions

public java.lang.String[] getOptions()
Gets the current settings of the filter.

Specified by:
getOptions in interface OptionHandler
Returns:
an array of strings suitable for passing to setOptions.

globalInfo

public java.lang.String globalInfo()
Returns a string describing this filter

Returns:
a description of the filter suitable for displaying in the GUI.

instancesIndicesTipText

public java.lang.String instancesIndicesTipText()
Returns the tip text for this property

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

getInstancesIndices

public java.lang.String getInstancesIndices()
Gets ranges of instances selected.

Returns:
a string containing a comma-separated list of ranges

setInstancesIndices

public void setInstancesIndices(java.lang.String rangeList)
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:
java.lang.IllegalArgumentException - if an invalid range list is supplied

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

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

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

setInputFormat

public boolean setInputFormat(Instances instanceInfo)
                       throws java.lang.Exception
Sets the format of the input instances.

Overrides:
setInputFormat in class Filter
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:
java.lang.Exception - if the input format can't be set successfully

input

public boolean input(Instance instance)
Input an instance for filtering. Filter requires all training instances be read before producing output.

Overrides:
input in class Filter
Parameters:
instance - the input instance
Returns:
true if the filtered instance may now be collected with output().
Throws:
java.lang.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:
batchFinished in class Filter
Returns:
true if there are instances pending output
Throws:
java.lang.IllegalStateException - if no input structure has been defined

main

public static void main(java.lang.String[] argv)
Main method for testing this class.

Parameters:
argv - should contain arguments to the filter: use -h for help