magpie.data.utilities.filters

Class ClassFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.ComparisonOperatorFilter

magpie.data.utilities.filters.ClassFilter

All Implemented Interfaces:

java.io.Serializable, Options

public class ClassFilter
extends ComparisonOperatorFilter

Filter entries based on value of class variable.

Usage: <measured|predicted> <Criteria> <Threshold>
measured|predicted: Whether to use measured or predicted class variable
Criteria: Comparison operator used to filter data
Threshold: Value to which class is compared

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	UseMeasured Whether to use measured class variable

Fields inherited from class magpie.data.utilities.filters.ComparisonOperatorFilter

Equal, GreaterThan, LessThan, Threshold

Constructor Summary

Constructors

Constructor and Description
ClassFilter()

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	setOptions(java.lang.String Measured, java.lang.String Criteria, java.lang.String Threshold) Configure the filter by defining which entries should be kept
void	setUseMeasured(boolean value) Set whether to use the measured class variable.
void	train(Dataset TrainingSet) Train a dataset splitter, if necessary

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

setComparisonOperator, setThreshold, testCriteria

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

Field Detail

UseMeasured

protected boolean UseMeasured

Whether to use measured class variable

Constructor Detail

ClassFilter

public ClassFilter()

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

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

setUseMeasured

public void setUseMeasured(boolean value)

Set whether to use the measured class variable.

Parameters:

value - Desired setting

setOptions

public void setOptions(java.lang.String Measured,
                       java.lang.String Criteria,
                       java.lang.String Threshold)
                throws java.lang.Exception

Configure the filter by defining which entries should be kept

Parameters:

Measured - Should be either measured or predicted

Criteria - Criteria used to test for inclusion

Threshold - Threshold used to test for inclusion

Throws:

java.lang.Exception

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