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

Class weka.filters.unsupervised.instance.Resample 

java.lang.Object
    |
    +----weka.filters.Filter
            |
            +----weka.filters.unsupervised.instance.Resample
public class Resample
extends Filter
implements UnsupervisedFilter, OptionHandler
Produces a random subsample of a dataset. The original dataset must fit entirely in memory. The number of instances in the generated dataset may be specified. When used in batch mode, subsequent batches are not resampled. Valid options are:

-S num
Specify the random number seed (default 1).

-Z percent
Specify the size of the output dataset, as a percentage of the input dataset (default 100).

Version:
$Revision: 1.2 $
Author:
Len Trigg (len@reeltwo.com)

Constructor Index

o Resample()
 

Method Index

o batchFinished()
Signify that this batch of input to the filter is finished.
o getOptions()
Gets the current settings of the filter.
o getRandomSeed()
Gets the random number seed.
o getSampleSizePercent()
Gets the subsample size as a percentage of the original set.
o input(Instance)
Input an instance for filtering.
o listOptions()
Returns an enumeration describing the available options.
o main(String[])
Main method for testing this class.
o setInputFormat(Instances)
Sets the format of the input instances.
o setOptions(String[])
Parses a list of options for this object.
o setRandomSeed(int)
Sets the random number seed.
o setSampleSizePercent(double)
Sets the size of the subsample, as a percentage of the original set.

Constructor Detail

o Resample
public Resample()

Method Detail

o listOptions
public java.util.Enumeration listOptions()
          Returns an enumeration describing the available options.
Returns:
an enumeration of all the available options.
o setOptions
public void setOptions(java.lang.String options[]) throws java.lang.Exception
          Parses a list of options for this object. Valid options are:

-S num
Specify the random number seed (default 1).

-Z percent
Specify the size of the output dataset, as a percentage of the input dataset (default 100).

Parameters:
options - the list of options as an array of strings
Throws:
java.lang.Exception - if an option is not supported
o getOptions
public java.lang.String[] getOptions()
          Gets the current settings of the filter.
Returns:
an array of strings suitable for passing to setOptions
o getRandomSeed
public int getRandomSeed()
          Gets the random number seed.
Returns:
the random number seed.
o setRandomSeed
public void setRandomSeed(int newSeed)
          Sets the random number seed.
Parameters:
newSeed - the new random number seed.
o getSampleSizePercent
public double getSampleSizePercent()
          Gets the subsample size as a percentage of the original set.
Returns:
the subsample size
o setSampleSizePercent
public void setSampleSizePercent(double newSampleSizePercent)
          Sets the size of the subsample, as a percentage of the original set.
Parameters:
newSampleSizePercent - the subsample set size, between 0 and 100.
o 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 if the outputFormat may be collected immediately
Throws:
java.lang.Exception - if the input format can't be set successfully
Overrides:
setInputFormat in class Filter
o input
public boolean input(Instance instance)
          Input an instance for filtering. Filter requires all training instances be read before producing output.
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
Overrides:
input in class Filter
o batchFinished
public boolean batchFinished()
          Signify that this batch of input to the filter is finished. If the filter requires all instances prior to filtering, 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
o 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