weka.filters.supervised.instance

Class RUS

java.lang.Object

weka.filters.Filter

weka.filters.supervised.instance.RUS

All Implemented Interfaces:

java.io.Serializable, weka.core.CapabilitiesHandler, weka.core.OptionHandler, weka.core.RevisionHandler, weka.core.TechnicalInformationHandler, weka.filters.SupervisedFilter

public class RUS
extends weka.filters.Filter
implements weka.filters.SupervisedFilter, weka.core.OptionHandler, weka.core.TechnicalInformationHandler

A filter that eliminates some random majority instances until the total amount of majority instances reaches the percentage given.

Valid options are:

 -P <Percentage>
  Specifies the proportion of final majority class respecting the minority class. (default 75).
  If the percentage specified is higher than the current majority percentage, the filter does nothing,
  else, the filter eliminates majority classes randomly until the majority proportion reaches the specified percentage.
 

Version:

$Revision: 1 $

Author:

Sergio García Charameli, Daniel Rodríguez - University of Alcalá

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RUS()

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.
java.lang.String[]	getOptions() Gets the current settings of the filter.
double	getPercentage() Gets the percentage of the proportion of majority class.
java.lang.String	getRevision() Returns the revision string.
weka.core.TechnicalInformation	getTechnicalInformation() Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
java.lang.String	globalInfo() Returns a string describing this filter.
boolean	input(weka.core.Instance instance) Input an instance for filtering.
java.util.Enumeration	listOptions() Returns an enumeration describing the available options.
static void	main(java.lang.String[] args) Main method for running this filter.
java.lang.String	percentageTipText() Returns the tip text for this property.
boolean	setInputFormat(weka.core.Instances instanceInfo) Sets the format of the input instances.
void	setOptions(java.lang.String[] options) Parses a given list of options.
void	setPercentage(double value) Sets the percentage of the proportion of majority class.

Methods inherited from class weka.filters.Filter

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RUS

public RUS()

Method Detail

globalInfo

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

getTechnicalInformation

public weka.core.TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface weka.core.TechnicalInformationHandler

Returns:

the technical information about this class

getRevision

public java.lang.String getRevision()

Returns the revision string.

Specified by:

getRevision in interface weka.core.RevisionHandler

Overrides:

getRevision in class weka.filters.Filter

Returns:

the revision

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

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:

 -P <Percentage>
  Specifies the proportion of final majority class respecting the minority class. (default 75).
  If the percentage specified is higher than the current majority percentage, the filter does nothing,
  else, the filter eliminates majority classes randomly until the majority proportion reaches the specified percentage.
 

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

percentageTipText

public java.lang.String percentageTipText()

Returns the tip text for this property.

Returns:

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

setPercentage

public void setPercentage(double value)

Sets the percentage of the proportion of majority class.

Parameters:

value - the percentage to use

getPercentage

public double getPercentage()

Gets the percentage of the proportion of majority class.

Returns:

the percentage of the proportion of majority class.

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.Exception - if the input format 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()
                      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.

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

java.lang.Exception - if provided options cannot be executed on input instances

main

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

Main method for running this filter.

Parameters:

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