magpie.data.utilities.filters

Class IQROutlierFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.IQROutlierFilter

All Implemented Interfaces:

java.io.Serializable, Options

public class IQROutlierFilter
extends BaseDatasetFilter

Filters entries based on whether the class values are outliers using the interquartile range. Any entry with a measured class variable more than a certain number of interquartile ranges from the median is classified as an outlier

Usage: <threshold>
threshold: Fraction of interquartile range away from median that data is considered an outlier.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IQROutlierFilter()

Method Summary

Modifier and Type	Method and Description
boolean[]	label(Dataset D) Given a dataset, determine which entries passes the filter.
java.lang.String	printUsage() Print out required format for options.
void	setOptions(java.util.List<java.lang.Object> OptionsObj) Set any options for this object.
void	setThreshold(double Threshold) Define number of IQRs away from the median that an entries is an outliers.
void	train(Dataset TrainingSet) Train a dataset splitter, if necessary

Methods inherited from class magpie.data.utilities.filters.BaseDatasetFilter

filter, parallelLabel, parallelMinimum, setExclude, toExclude

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IQROutlierFilter

public IQROutlierFilter()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> OptionsObj)
                throws java.lang.Exception

Description copied from interface: Options

Set any options for this object. If parsing the options fails, return an Exception with the usage as its message.

Parameters:

OptionsObj - Array of options as Objects - can be null

Throws:

java.lang.Exception - if problem with inputs

setThreshold

public void setThreshold(double Threshold)

Define number of IQRs away from the median that an entries is an outliers.

Parameters:

Threshold - Desired threshold (default = 2)

printUsage

public java.lang.String printUsage()

Description copied from interface: Options

Print out required format for options. For consistency, should start with "Usage: ".

Returns:

Usage for this function

label

public boolean[] label(Dataset D)

Description copied from class: BaseDatasetFilter

Given a dataset, determine which entries passes the filter. Please ensure that D remains unaltered (clone if you must)

Specified by:

label in class BaseDatasetFilter

Parameters:

D - Dataset to be labeled

Returns:

A list of booleans marking whether an entry passes

train

public void train(Dataset TrainingSet)

Description copied from class: BaseDatasetFilter

Train a dataset splitter, if necessary

Specified by:

train in class BaseDatasetFilter

Parameters:

TrainingSet - Dataset to use for training