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

Class weka.filters.unsupervised.instance.RemoveFolds

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

public class RemoveFolds

extends Filter

implements UnsupervisedFilter, OptionHandler

-V
Specifies if inverse of selection is to be output.

-N number of folds
Specifies number of folds dataset is split into (default 10).

-F fold
Specifies which fold is selected. (default 1)

-S seed
Specifies a random number seed for shuffling the dataset. (default 0, don't randomize)

Version:

$Revision: 1.1 $

Author:

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

RemoveFolds()

 

batchFinished()

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

foldTipText()

Returns the tip text for this property

getFold()

Gets the fold which is selected.

getInvertSelection()

Gets if selection is to be inverted.

getNumFolds()

Gets the number of folds in which dataset is to be split into.

getOptions()

Gets the current settings of the filter.

getSeed()

Gets the random number seed used for shuffling the dataset.

globalInfo()

Returns a string describing this filter

invertSelectionTipText()

Returns the tip text for this property

listOptions()

Gets an enumeration describing the available options..

main(String[])

Main method for testing this class.

numFoldsTipText()

Returns the tip text for this property

seedTipText()

Returns the tip text for this property

setFold(int)

Selects a fold.

setInputFormat(Instances)

Sets the format of the input instances.

setInvertSelection(boolean)

Sets if selection is to be inverted.

setNumFolds(int)

Sets the number of folds the dataset is split into.

setOptions(String[])

Parses the options for this object.

setSeed(long)

Sets the random number seed for shuffling the dataset.

public RemoveFolds()

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:

-V
Specifies if inverse of selection is to be output.

-N number of folds
Specifies number of folds dataset is split into (default 10).

-F fold
Specifies which fold is selected. (default 1)

-S seed
Specifies a random number seed for shuffling the dataset. (default 0, no randomizing)

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 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 java.lang.String numFoldsTipText()

          Returns the tip text for this property

Returns:

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

public int getNumFolds()

          Gets the number of folds in which dataset is to be split into.

Returns:

the number of folds the dataset is to be split into.

public void setNumFolds(int numFolds)

          Sets the number of folds the dataset is split into. If the number of folds is zero, it won't split it into folds.

Parameters:

numFolds - number of folds dataset is to be split into

Throws:

java.lang.IllegalArgumentException - if number of folds is negative

public java.lang.String foldTipText()

          Returns the tip text for this property

Returns:

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

public int getFold()

          Gets the fold which is selected.

Returns:

the fold which is selected

public void setFold(int fold)

          Selects a fold.

Parameters:

fold - the fold to be selected.

Throws:

java.lang.IllegalArgumentException - if fold's index is smaller than 1

public java.lang.String seedTipText()

          Returns the tip text for this property

Returns:

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

public long getSeed()

          Gets the random number seed used for shuffling the dataset.

Returns:

the random number seed

public void setSeed(long seed)

          Sets the random number seed for shuffling the dataset. If seed is negative, shuffling won't be performed.

Parameters:

seed - the random number seed

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