All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home

Class weka.filters.unsupervised.instance.RemoveRange

java.lang.Object
    |
    +----weka.filters.Filter
            |
            +----weka.filters.unsupervised.instance.RemoveRange

public class RemoveRange

extends Filter

implements UnsupervisedFilter, OptionHandler

-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.1 $

Author:

Eibe Frank (eibe@cs.waikato.ac.nz)

RemoveRange()

 

batchFinished()

Signify that this batch of input to the filter is finished.

getInstancesIndices()

Gets ranges of instances selected.

getInvertSelection()

Gets if selection is to be inverted.

getOptions()

Gets the current settings of the filter.

globalInfo()

Returns a string describing this filter

instancesIndicesTipText()

Returns the tip text for this property

invertSelectionTipText()

Returns the tip text for this property

listOptions()

Gets an enumeration describing the available options..

main(String[])

Main method for testing this class.

setInputFormat(Instances)

Sets the format of the input instances.

setInstancesIndices(String)

Sets the ranges of instances to be selected.

setInvertSelection(boolean)

Sets if selection is to be inverted.

setOptions(String[])

Parses the options for this object.

public RemoveRange()

public java.util.Enumeration listOptions()

          Gets an enumeration describing the available options..

Returns:

an enumeration of all the available options.

public void setOptions(java.lang.String options[]) throws java.lang.Exception

          Parses the options for this object. 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.

Parameters:

options - the list of options as an array of strings

Throws:

java.lang.Exception - if an option is not supported

public java.lang.String[] getOptions()

          Gets the current settings of the filter.

Returns:

an array of strings suitable for passing to setOptions

public java.lang.String globalInfo()

          Returns a string describing this filter

Returns:

a description of the filter suitable for displaying in the explorer/experimenter gui

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

public java.lang.String getInstancesIndices()

          Gets ranges of instances selected.

Returns:

a string containing a comma-separated list of ranges

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

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

public boolean getInvertSelection()

          Gets if selection is to be inverted.

Returns:

true if the selection is to be inverted

public void setInvertSelection(boolean inverse)

          Sets if selection is to be inverted.

Parameters:

inverse - true if inversion is to be performed

public boolean setInputFormat(Instances instanceInfo) throws java.lang.Exception

          Sets the format of the input instances.

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

Overrides:

setInputFormat in class Filter

public boolean batchFinished()

          Signify that this batch of input to the filter is finished. Output() may now be called to retrieve the filtered instances.

Returns:

true if there are instances pending output

Throws:

java.lang.IllegalStateException - if no input structure has been defined

Overrides:

batchFinished in class Filter

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

All Packages  Class Hierarchy  This Package  Previous  Next  Index  WEKA's home