magpie.data.utilities.filters

Class MultiFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.MultiFilter

All Implemented Interfaces:

java.io.Serializable, Options

public class MultiFilter
extends BaseDatasetFilter

Filter that incorporates multiple other filters. User supplies multiple filters, which are processed sequentially. For each filter:

1. Any entries that did not pass previous filter are ignored
2. Label operation is calculated to determine which (of the remaining) entries pass this filter
3. If the filter is set to exclude those entries, each result from 1 is logically negated
4. For the entries that passed previous filter, results are updated

Usage: -filter <include|exclude> <name> <options...> [-filter <...>]
include|exclude: Whether to include or exclude entries that pass this filter
name: Name of filtering method
options: Options for that filter
You can add as many filters as you want, just put "-filter" between each definition. Syntax is the same as for the first filter. Filters are executed sequentially.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<BaseDatasetFilter>	Filters List of filters currently in use

Constructor Summary

Constructors

Constructor and Description
MultiFilter()

Method Summary

Modifier and Type	Method and Description
void	addFilter(BaseDatasetFilter filter) Append filter to the current list of filters in use
void	clearFilters() Clear list of filters.
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> Options) Set any options for this object.
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

Field Detail

Filters

protected java.util.List<BaseDatasetFilter> Filters

List of filters currently in use

Constructor Detail

MultiFilter

public MultiFilter()

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

clearFilters

public void clearFilters()

Clear list of filters.

addFilter

public void addFilter(BaseDatasetFilter filter)

Append filter to the current list of filters in use

Parameters:

filter - Filter to be added

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