All Packages Class Hierarchy This Package Previous Next Index WEKA's home
Class weka.filters.SplitDatasetFilter
java.lang.Object
|
+----weka.filters.Filter
|
+----weka.filters.SplitDatasetFilter
- public class SplitDatasetFilter
- extends Filter
- implements OptionHandler
This filter takes a dataset and outputs a subset of it. If a class
attribute is assigned, the dataset will be stratified when fold-based
splitting.
Valid options are:
-R inst1,inst2-inst4,...
Specifies list of instances to select. First
and last are valid indexes. (default fold-based splitting)
-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)
-A
If set, data is not being stratified even if class index is set.
- Version:
- $Revision: 1.11.2.1 $
- Author:
- Eibe Frank (eibe@cs.waikato.ac.nz)
SplitDatasetFilter()
-
batchFinished()
- Signify that this batch of input to the filter is
finished.
getDontStratifyData()
- Gets whether stratification is not performed.
getFold()
- Gets the fold which is selected.
getInstancesIndices()
- Gets ranges of instances 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.
listOptions()
- Gets an enumeration describing the available options.
main(String[])
- Main method for testing this class.
setDontStratifyData(boolean)
- Sets whether stratification is not performed.
setFold(int)
- Selects a fold.
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.
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.
SplitDatasetFilter
public SplitDatasetFilter()
listOptions
public java.util.Enumeration listOptions()
Gets an enumeration describing the available options.
- Returns:
- an enumeration of all the available options
setOptions
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. (default fold-based splitting)
-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)
-A
If set, data is not being stratified even if class index is set.
- Parameters:
options
- the list of options as an array of strings
- Throws:
- java.lang.Exception - if an option is not supported
getOptions
public java.lang.String[] getOptions()
Gets the current settings of the filter.
- Returns:
- an array of strings suitable for passing to setOptions
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
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
getNumFolds
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.
setNumFolds
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
getFold
public int getFold()
Gets the fold which is selected.
- Returns:
- the fold which is selected
setFold
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
getSeed
public long getSeed()
Gets the random number seed used for shuffling the dataset.
- Returns:
- the random number seed
setSeed
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
setDontStratifyData
public void setDontStratifyData(boolean flag)
Sets whether stratification is not performed.
getDontStratifyData
public boolean getDontStratifyData()
Gets whether stratification is not performed.
setInputFormat
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
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.
- Returns:
- true if there are instances pending output
- Throws:
- java.lang.IllegalStateException - if no input structure has been defined
- Overrides:
- batchFinished in class Filter
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
All Packages Class Hierarchy This Package Previous Next Index WEKA's home