magpie.data.utilities.filters

Class EntryRankerFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.EntryRankerFilter

All Implemented Interfaces:

java.io.Serializable, Options

public class EntryRankerFilter
extends BaseDatasetFilter

Filter entries based on ranking. Lets the user pick the number of entries to keep, whether to select the best or lest fit, use the predicted or measured class, and then the overall method and its options. Consequently, the "Usage" is pretty messy.

Usage: <number> <maximum|minimum> <predicted|measured> <method> [<options...>]
number: Number of entries that pass this filter
maximum|minimum: Whether entries with a max/minimum value pass the filter
method: Objective function used to rank entries. Name of an BaseEntryRanker ("?" for available methods)
options...: Any options for the objective function

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EntryRankerFilter()

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	setNumberToFilter(int NumberToFilter) Define how many entries will pass this filter
void	setOptions(java.util.List<java.lang.Object> OptionsObj) Set any options for this object.
void	setRanker(BaseEntryRanker Ranker) Define the ranker used to filter entries.
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

EntryRankerFilter

public EntryRankerFilter()

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

setNumberToFilter

public void setNumberToFilter(int NumberToFilter)

Define how many entries will pass this filter

Parameters:

NumberToFilter - Desired number

setRanker

public void setRanker(BaseEntryRanker Ranker)

Define the ranker used to filter entries.

Parameters:

Ranker - Desired ranker

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