weka.filters.unsupervised.instance

Class ENN

java.lang.Object

weka.filters.Filter

weka.filters.unsupervised.instance.ENN

All Implemented Interfaces:

java.io.Serializable, weka.core.CapabilitiesHandler, weka.core.OptionHandler, weka.core.RevisionHandler, weka.filters.UnsupervisedFilter

public class ENN
extends weka.filters.Filter
implements weka.filters.UnsupervisedFilter, weka.core.OptionHandler

Implements a ENN over-sampling algorithm. The minority classes are over-sampled by creating “synthetic” examples

Valid options are:

 -N <num>
  Specify the ENN over-sampling factor (default 1)

 -K <num>
  Specify the factor of nearest neighbors for each
  minority class sample (default 2)

 -I
  Inverts percent values for minority classes

 -P <num>
  Specify a percent value to decide when a class  
  is a minority class (default 50)

Version:

$Revision: 1.0 $

Author:

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ENN.LinearNNSearchENN

Constructor Summary

Constructors

Constructor and Description
ENN()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	batchFinished() Signify that this batch of input to the filter is finished.
weka.core.Capabilities	getCapabilities() Returns the Capabilities of this filter.
int	getKNeighborsFactor() Gets the factor of nearest neighbors for each minority class sample
java.lang.String[]	getOptions() Gets the current settings of the filter.
int	getRandomSeed() Gets the random number seed.
java.lang.String	globalInfo() Returns a string describing this classifier
boolean	input(weka.core.Instance instance) Input an instance for filtering.
java.lang.String	KNeighborsFactorTipText() Returns the tip text for this property
java.util.Enumeration	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main method for testing this class.
java.lang.String	randomSeedTipText() Returns the tip text for this property
static void	runFilter(weka.filters.Filter filter, java.lang.String[] options) runs the filter instance with the given options.
boolean	setInputFormat(weka.core.Instances instanceInfo) Sets the format of the input instances.
void	setKNeighborsFactor(int nNeighbors) Sets the factor of nearest neighbors for each minority class sample
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setRandomSeed(int newSeed) Sets the random number seed.

Methods inherited from class weka.filters.Filter

batchFilterFile, filterFile, getCapabilities, getOutputFormat, getRevision, isFirstBatchDone, isNewBatch, isOutputFormatDefined, makeCopies, makeCopy, mayRemoveInstanceAfterFirstBatchDone, numPendingOutput, output, outputPeek, toString, useFilter, wekaStaticWrapper

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ENN

public ENN()

Method Detail

globalInfo

public java.lang.String globalInfo()

Returns a string describing this classifier

Returns:

a description of the classifier suitable for displaying in the explorer/experimenter gui

listOptions

public java.util.Enumeration listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Returns:

an enumeration of all the available options.

setOptions

public void setOptions(java.lang.String[] options)
                throws java.lang.Exception

Parses a given list of options.

Valid options are:

 -K <num>
  Specify the factor of nearest neighbors for each
  minority class sample (default 2)

Specified by:

setOptions in interface weka.core.OptionHandler

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.

Specified by:

getOptions in interface weka.core.OptionHandler

Returns:

an array of strings suitable for passing to setOptions

randomSeedTipText

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

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.

KNeighborsFactorTipText

public java.lang.String KNeighborsFactorTipText()

Returns the tip text for this property

Returns:

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

getKNeighborsFactor

public int getKNeighborsFactor()

Gets the factor of nearest neighbors for each minority class sample

Returns:

the factor of nearest neighbors for each minority class sample

setKNeighborsFactor

public void setKNeighborsFactor(int nNeighbors)

Sets the factor of nearest neighbors for each minority class sample

Parameters:

nKNF - factor of nearest neighbors for each minority class sample

getCapabilities

public weka.core.Capabilities getCapabilities()

Returns the Capabilities of this filter.

Specified by:

getCapabilities in interface weka.core.CapabilitiesHandler

Overrides:

getCapabilities in class weka.filters.Filter

Returns:

the capabilities of this object

See Also:

Capabilities

setInputFormat

public boolean setInputFormat(weka.core.Instances instanceInfo)
                       throws java.lang.Exception

Sets the format of the input instances.

Overrides:

setInputFormat in class weka.filters.Filter

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.IllegalArgumentException - if the input format can't be set successfully

java.lang.Exception - if the inputFormat can't be set successfully

input

public boolean input(weka.core.Instance instance)

Input an instance for filtering. Filter requires all training instances be read before producing output.

Overrides:

input in class weka.filters.Filter

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

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 class weka.filters.Filter

Returns:

true if there are instances pending output

Throws:

java.lang.IllegalStateException - if no input structure has been defined

runFilter

public static void runFilter(weka.filters.Filter filter,
             java.lang.String[] options)

runs the filter instance with the given options.

Parameters:

filter - the filter to run

options - the command line options

main

public static void main(java.lang.String[] args)

Main method for testing this class.

Parameters:

args - should contain arguments to the filter: use -h for help