magpie.data.utilities.splitters

Class FilterSplitter

java.lang.Object

magpie.data.utilities.splitters.BaseDatasetSplitter

magpie.data.utilities.splitters.FilterSplitter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Commandable, Options, Printable

public class FilterSplitter
extends BaseDatasetSplitter

Split entries based on whether they pass a BaseDatasetFilter. Entries that pass are placed in split 0 and those that do not pass are placed in 1.

Usage: $lt;filter>

filter: BaseDatasetFilter used to partition data

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseDatasetFilter	Filter Filter used for splitting the data

Constructor Summary

Constructors

Constructor and Description
FilterSplitter()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getSplitNames() Get the names of the splits this splitter creates
protected java.util.List<java.lang.String>	getSplitterDetails(boolean htmlFormat) Get details of splitter.
int[]	label(Dataset D) Given a dataset, determine which subset each entry should belong to.
java.lang.String	printUsage() Print out required format for options.
void	setFilter(BaseDatasetFilter filter) Set the filter used to partition data
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.splitters.BaseDatasetSplitter

about, clone, printCommand, printDescription, runCommand, split, split

Methods inherited from class java.lang.Object

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

Field Detail

Filter

protected BaseDatasetFilter Filter

Filter used for splitting the data

Constructor Detail

FilterSplitter

public FilterSplitter()

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

setFilter

public void setFilter(BaseDatasetFilter filter)

Set the filter used to partition data

Parameters:

filter - Desired filter

train

public void train(Dataset TrainingSet)

Description copied from class: BaseDatasetSplitter

Train a dataset splitter, if necessary

Specified by:

train in class BaseDatasetSplitter

Parameters:

TrainingSet - Dataset to use for training

label

public int[] label(Dataset D)

Description copied from class: BaseDatasetSplitter

Given a dataset, determine which subset each entry should belong to. Please ensure that D remains unaltered (clone if you must)

Specified by:

label in class BaseDatasetSplitter

Parameters:

D - Dataset to be labeled

Returns:

A list of nonnegative integers marking which subset to split each entry into

getSplitNames

public java.util.List<java.lang.String> getSplitNames()

Description copied from class: BaseDatasetSplitter

Get the names of the splits this splitter creates

Specified by:

getSplitNames in class BaseDatasetSplitter

Returns:

Names of each group

getSplitterDetails

protected java.util.List<java.lang.String> getSplitterDetails(boolean htmlFormat)

Description copied from class: BaseDatasetSplitter

Get details of splitter. Returns a list of options that can be set by the user. Used with BaseDatasetSplitter.printDescription(boolean).

Specified by:

getSplitterDetails in class BaseDatasetSplitter

Parameters:

htmlFormat - Whether to format results with HTML

Returns:

List of options describing the model