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

Class weka.filters.unsupervised.attribute.AddNoise

java.lang.Object
    |
    +----weka.filters.Filter
            |
            +----weka.filters.unsupervised.attribute.AddNoise

public class AddNoise

extends Filter

implements UnsupervisedFilter, OptionHandler

-C col
Index of the attribute to be changed. (default last)

-M
flag: missing values are treated as an extra value

-P num
Percentage of noise to be introduced to the data (default 10).

-S seed
Random number seed for choosing the data to be changed

and for choosing the value it is changed to (default 1).

Version:

$Revision: 1.1 $

Author:

Gabi Schmidberger (gabi@cs.waikato.ac.nz)

AddNoise()

 

addNoise(Instances, int, int, int, boolean)

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.

attIndexSetTipText()

Returns the tip text for this property

batchFinished()

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

getAttIndexSet()

Gets the Index of the Attribute that is to be changed.

getOptions()

Gets the current settings of the filter.

getPercent()

Gets the size of noise data as a percentage of the original set.

getRandomSeed()

Gets the random number seed.

getUseMissing()

Gets the flag if missing values are treated as extra values.

globalInfo()

Returns a string describing this filter

input(Instance)

Input an instance for filtering.

listOptions()

Returns an enumeration describing the available options

main(String[])

Main method for testing this class.

percentTipText()

Returns the tip text for this property

randomSeedTipText()

Returns the tip text for this property

setAttIndexSet(int)

Sets the Index of the Attribute to be changed.

setInputFormat(Instances)

Sets the format of the input instances.

setOptions(String[])

Parses a list of options for this object.

setPercent(int)

Sets the size of noise data, as a percentage of the original set.

setRandomSeed(int)

Sets the random number seed.

setUseMissing(boolean)

Sets the flag if missing values are treated as extra values.

useMissingTipText()

Returns the tip text for this property

public AddNoise()

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.util.Enumeration listOptions()

          Returns 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 a list of options for this object. Valid options are:

-C col
Index of the attribute to be changed. (default last)

-M
missing values are treated as an extra value

-P num
Specify the percentage of noise introduced to the data (default 10).

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

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 useMissingTipText()

          Returns the tip text for this property

Returns:

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

public boolean getUseMissing()

          Gets the flag if missing values are treated as extra values.

Returns:

the flag missing values.

public void setUseMissing(boolean newUseMissing)

          Sets the flag if missing values are treated as extra values.

Parameters:

newUseMissing - the new flag value.

public java.lang.String randomSeedTipText()

          Returns the tip text for this property

Returns:

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

public int getRandomSeed()

          Gets the random number seed.

Returns:

the random number seed.

public void setRandomSeed(int newSeed)

          Sets the random number seed.

Parameters:

newSeed - the new random number seed.

public java.lang.String percentTipText()

          Returns the tip text for this property

Returns:

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

public int getPercent()

          Gets the size of noise data as a percentage of the original set.

Returns:

the noise data size

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.

public java.lang.String attIndexSetTipText()

          Returns the tip text for this property

Returns:

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

public int getAttIndexSet()

          Gets the Index of the Attribute that is to be changed.

Returns:

the attribute index that is to be changed

public void setAttIndexSet(int newAttIndexSet)

          Sets the Index of the Attribute to be changed.

Parameters:

newAttIndexSet - index of the attribute to be changed.

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

public boolean input(Instance instance) throws java.lang.Exception

          Input an instance for filtering.

Parameters:

instance - the input instance

Returns:

true if the filtered instance may now be collected with output().

Throws:

java.lang.Exception - if the input format was not set

Overrides:

input in class Filter

public boolean batchFinished() throws java.lang.Exception

          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.Exception - if no input structure has been defined

Overrides:

batchFinished in class Filter

public void addNoise(Instances instances,
                     int seed,
                     int percent,
                     int attIndex,
                     boolean useMissing)

          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 with leaving the apportion the same. if m_UseMissing is true, missing value is used as a value of its own

Parameters:

instances - is the dataset

seed - used for random function

percent - percentage of instances that are changed

attIndex - index of the attribute changed

useMissingValue - if true missing values are treated as extra value

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