magpie.data.utilities.filters

Class ClassProbabilityFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.ClassProbabilityFilter

All Implemented Interfaces:

java.io.Serializable, Options

public class ClassProbabilityFilter
extends BaseDatasetFilter

Filter based on predicted probability that an entry is a certain class.

Example use: Filtering out all compounds more than 50% likely to be metallic.

Usage: <class> <min probability>
class: Name of class used for filtering
min probability: Probability threshold. Any entry with a predicted probability of being "class" greater than this threshold is filtered

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassProbabilityFilter()

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	setClassName(java.lang.String name) Set the name of the class considered for filtering.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setThreshold(double threshold) Set the probability threshold used for filtering.
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

ClassProbabilityFilter

public ClassProbabilityFilter()

Method Detail

setOptions

public void setOptions(java.util.List<java.lang.Object> Options)
                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:

Options - 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

setClassName

public void setClassName(java.lang.String name)

Set the name of the class considered for filtering.

Parameters:

name - Name of target class

setThreshold

public void setThreshold(double threshold)
                  throws java.lang.Exception

Set the probability threshold used for filtering. Any entry with a predicted probability less than this value is filtered.

Parameters:

threshold - Desired threshold. Must be between 0 and 1.

Throws:

java.lang.Exception

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

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