Class Resample
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.instance.Resample
- All Implemented Interfaces:
Serializable
,CapabilitiesHandler
,OptionHandler
,RevisionHandler
,UnsupervisedFilter
Produces a random subsample of a dataset using either sampling with replacement or without replacement. 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 <num> The size of the output dataset, as a percentage of the input dataset (default 100)
-no-replacement Disables replacement of instances (default: with replacement)
-V Inverts the selection - only available with '-no-replacement'.
- Version:
- $Revision: 5548 $
- Author:
- Len Trigg (len@reeltwo.com), FracPete (fracpete at waikato dot ac dot nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Signify that this batch of input to the filter is finished.void
createSubsampleWithoutReplacement
(Random random, int origSize, int sampleSize) creates the subsample without replacementvoid
createSubsampleWithReplacement
(Random random, int origSize, int sampleSize) creates the subsample with replacementReturns the Capabilities of this filter.boolean
Gets whether selection is inverted (only if instances are drawn WIHTOUT replacement).boolean
Gets whether instances are drawn with or without replacement.String[]
Gets the current settings of the filter.int
Gets the random number seed.Returns the revision string.double
Gets the subsample size as a percentage of the original set.Returns a string describing this classifierboolean
Input an instance for filtering.Returns the tip text for this propertyReturns an enumeration describing the available options.static void
Main method for testing this class.Returns the tip text for this propertyReturns the tip text for this propertyReturns the tip text for this propertyboolean
setInputFormat
(Instances instanceInfo) Sets the format of the input instances.void
setInvertSelection
(boolean value) Sets whether the selection is inverted (only if instances are drawn WIHTOUT replacement).void
setNoReplacement
(boolean value) Sets whether instances are drawn with or with out replacement.void
setOptions
(String[] options) Parses a given list of options.void
setRandomSeed
(int newSeed) Sets the random number seed.void
setSampleSizePercent
(double newSampleSizePercent) Sets the size of the subsample, as a percentage of the original set.Methods inherited from class weka.filters.Filter
batchFilterFile, filterFile, getCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
Resample
public Resample()
-
-
Method Details
-
globalInfo
Returns a string describing this classifier- Returns:
- a description of the classifier suitable for displaying in the explorer/experimenter gui
-
listOptions
Returns an enumeration describing the available options.- Specified by:
listOptions
in interfaceOptionHandler
- Returns:
- an enumeration of all the available options.
-
setOptions
Parses a given list of options. Valid options are:-S <num> Specify the random number seed (default 1)
-Z <num> The size of the output dataset, as a percentage of the input dataset (default 100)
-no-replacement Disables replacement of instances (default: with replacement)
-V Inverts the selection - only available with '-no-replacement'.
- Specified by:
setOptions
in interfaceOptionHandler
- Parameters:
options
- the list of options as an array of strings- Throws:
Exception
- if an option is not supported
-
getOptions
Gets the current settings of the filter.- Specified by:
getOptions
in interfaceOptionHandler
- Returns:
- an array of strings suitable for passing to setOptions
-
randomSeedTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getRandomSeed
public int getRandomSeed()Gets the random number seed.- Returns:
- the random number seed.
-
setRandomSeed
public void setRandomSeed(int newSeed) Sets the random number seed.- Parameters:
newSeed
- the new random number seed.
-
sampleSizePercentTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getSampleSizePercent
public double getSampleSizePercent()Gets the subsample size as a percentage of the original set.- Returns:
- the subsample size
-
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.
-
noReplacementTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getNoReplacement
public boolean getNoReplacement()Gets whether instances are drawn with or without replacement.- Returns:
- true if the replacement is disabled
-
setNoReplacement
public void setNoReplacement(boolean value) Sets whether instances are drawn with or with out replacement.- Parameters:
value
- if true then the replacement of instances is disabled
-
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 whether selection is inverted (only if instances are drawn WIHTOUT replacement).- Returns:
- true if the replacement is disabled
- See Also:
-
setInvertSelection
public void setInvertSelection(boolean value) Sets whether the selection is inverted (only if instances are drawn WIHTOUT replacement).- Parameters:
value
- if true then selection is inverted
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilities
in interfaceCapabilitiesHandler
- Overrides:
getCapabilities
in classFilter
- Returns:
- the capabilities of this object
- See Also:
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormat
in classFilter
- 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:
Exception
- if the input format can't be set successfully
-
input
Input an instance for filtering. Filter requires all training instances be read before producing output.- Overrides:
input
in classFilter
- Parameters:
instance
- the input instance- Returns:
- true if the filtered instance may now be collected with output().
- Throws:
IllegalStateException
- if no input structure has been defined
-
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.- Overrides:
batchFinished
in classFilter
- Returns:
- true if there are instances pending output
- Throws:
IllegalStateException
- if no input structure has been defined
-
createSubsampleWithReplacement
creates the subsample with replacement- Parameters:
random
- the random number generator to useorigSize
- the original size of the datasetsampleSize
- the size to generate
-
createSubsampleWithoutReplacement
creates the subsample without replacement- Parameters:
random
- the random number generator to useorigSize
- the original size of the datasetsampleSize
- the size to generate
-
getRevision
Returns the revision string.- Specified by:
getRevision
in interfaceRevisionHandler
- Overrides:
getRevision
in classFilter
- Returns:
- the revision
-
main
Main method for testing this class.- Parameters:
argv
- should contain arguments to the filter: use -h for help
-