Class AddNoise
java.lang.Object
weka.filters.Filter
weka.filters.unsupervised.attribute.AddNoise
- All Implemented Interfaces:
Serializable,CapabilitiesHandler,CapabilitiesIgnorer,CommandlineRunnable,OptionHandler,Randomizable,RevisionHandler,WeightedAttributesHandler,UnsupervisedFilter
public class AddNoise
extends Filter
implements UnsupervisedFilter, OptionHandler, Randomizable, WeightedAttributesHandler
An instance filter that changes a percentage of a
given attribute's values. The attribute must be nominal. Missing value can be
treated as a distinct separate value.
Valid options are:
-C <col> Index of the attribute to be changed (default last attribute)
-M Treat missing values as an extra value
-P <num> Specify the percentage of values that are changed (default 10)
-S <num> Specify the random number seed (default 1)
- Version:
- $Revision: 14534 $
- Author:
- Gabi Schmidberger (gabi@cs.waikato.ac.nz)
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidadd noise to the dataset a given percentage of the instances are changed in the way that a set of instances are randomly selected using seed.Returns the tip text for this propertybooleanSignify that this batch of input to the filter is finished.Get the index of the attribute used.Returns the Capabilities of this filter.String[]Gets the current settings of the filter.intGets the size of noise data as a percentage of the original set.intGets the random number seed.Returns the revision string.intgetSeed()Gets the seed for the random number generationsbooleanGets the flag if missing values are treated as extra values.Returns a string describing this filterbooleanInput an instance for filtering.Returns an enumeration describing the available optionsstatic voidMain method for testing this class.Returns the tip text for this propertyReturns the tip text for this propertyvoidsetAttributeIndex(String attIndex) Sets index of the attribute used.booleansetInputFormat(Instances instanceInfo) Sets the format of the input instances.voidsetOptions(String[] options) Parses a given list of options.voidsetPercent(int newPercent) Sets the size of noise data, as a percentage of the original set.voidsetRandomSeed(int newSeed) Sets the random number seed.voidsetSeed(int seed) Set the seed for random number generation.voidsetUseMissing(boolean newUseMissing) Sets the flag if missing values are treated as extra values.Returns the tip text for this propertyMethods inherited from class weka.filters.Filter
batchFilterFile, debugTipText, doNotCheckCapabilitiesTipText, filterFile, getCapabilities, getCopyOfInputFormat, getDebug, getDoNotCheckCapabilities, getOutputFormat, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, postExecution, preExecution, run, runFilter, setDebug, setDoNotCheckCapabilities, toString, useFilter, wekaStaticWrapper
-
Constructor Details
-
AddNoise
public AddNoise()
-
-
Method Details
-
globalInfo
Returns a string describing this filter- Returns:
- a description of the filter suitable for displaying in the explorer/experimenter gui
-
listOptions
Returns an enumeration describing the available options- Specified by:
listOptionsin interfaceOptionHandler- Overrides:
listOptionsin classFilter- Returns:
- an enumeration of all the available options
-
setOptions
Parses a given list of options. Valid options are:-C <col> Index of the attribute to be changed (default last attribute)
-M Treat missing values as an extra value
-P <num> Specify the percentage of values that are changed (default 10)
-S <num> Specify the random number seed (default 1)
- Specified by:
setOptionsin interfaceOptionHandler- Overrides:
setOptionsin classFilter- 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:
getOptionsin interfaceOptionHandler- Overrides:
getOptionsin classFilter- Returns:
- an array of strings suitable for passing to setOptions
-
useMissingTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getUseMissing
public boolean getUseMissing()Gets the flag if missing values are treated as extra values.- Returns:
- the flag missing values.
-
setUseMissing
public void setUseMissing(boolean newUseMissing) Sets the flag if missing values are treated as extra values.- Parameters:
newUseMissing- the new flag value.
-
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.
-
setSeed
Description copied from interface:RandomizableSet the seed for random number generation.- Specified by:
setSeedin interfaceRandomizable- Parameters:
seed- the seed
-
getSeed
Description copied from interface:RandomizableGets the seed for the random number generations- Specified by:
getSeedin interfaceRandomizable- Returns:
- the seed for the random number generation
-
percentTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getPercent
public int getPercent()Gets the size of noise data as a percentage of the original set.- Returns:
- the noise data size
-
setPercent
public void setPercent(int newPercent) Sets the size of noise data, as a percentage of the original set.- Parameters:
newPercent- the subsample set size, between 0 and 100.
-
attributeIndexTipText
Returns the tip text for this property- Returns:
- tip text for this property suitable for displaying in the explorer/experimenter gui
-
getAttributeIndex
Get the index of the attribute used.- Returns:
- the index of the attribute
-
setAttributeIndex
Sets index of the attribute used.- Parameters:
attIndex- the index of the attribute
-
getCapabilities
Returns the Capabilities of this filter.- Specified by:
getCapabilitiesin interfaceCapabilitiesHandler- Overrides:
getCapabilitiesin classFilter- Returns:
- the capabilities of this object
- See Also:
-
setInputFormat
Sets the format of the input instances.- Overrides:
setInputFormatin 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. -
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:
batchFinishedin classFilter- Returns:
- true if there are instances pending output
- Throws:
Exception- if no input structure has been defined
-
addNoise
add noise to the dataset a given percentage of the instances are changed in the way that a set of instances are randomly selected using seed. The attribute given by its index is changed from its current value to one of the other possibly ones, also randomly. This is done while leaving the proportion the same. If m_UseMissing is true, missing value is used as a value of its own- Parameters:
instances- is the datasetseed- used for random functionpercent- percentage of instances that are changedattIndex- index of the attribute changeduseMissing- if true missing values are treated as extra value
-
getRevision
Returns the revision string.- Specified by:
getRevisionin interfaceRevisionHandler- Overrides:
getRevisionin classFilter- Returns:
- the revision
-
main
Main method for testing this class.- Parameters:
argv- should contain arguments to the filter: use -h for help
-