magpie.data.utilities.filters

Class BestInAlloySystemFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.BestInAlloySystemFilter

All Implemented Interfaces:

java.io.Serializable, Options

public class BestInAlloySystemFilter
extends BaseDatasetFilter

Select only the best N entries from any one phase diagram. "Phase Diagram" is defined as the set of constituent elements for a certain composition (e.g., AlNi -> {Al,Ni{). Entries are only in the same diagram if they have the same set of constituent elements (ex: AlTiNi and AlNi are in different diagrams). Usage: <N> <maximum|minimum> <measured|predicted> <ranker method> [<ranker options...>]
N: Number of entries to pick per diagram
maximum|minimum: Whether to select the entries with the highest or lowest ranking score
measured|predicted: Whether to use measured or predicted values
ranker method: Name of a BaseEntryRanker used to score entries
ranker options: Any options for that ranker

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BestInAlloySystemFilter()

Method Summary

Modifier and Type	Method and Description
boolean[]	label(Dataset D) Given a dataset, determine which entries passes the filter.
protected int	parallelMinimum() Minimum number of entries to label in parallel.
java.lang.String	printUsage() Print out required format for options.
void	setNPerDiagram(int NPerDiagram) Set number of entries to collect per diagram
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.
void	setRanker(BaseEntryRanker Ranker) Set how to rank entries
void	train(Dataset TrainingSet) Train a dataset splitter, if necessary

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

filter, parallelLabel, setExclude, toExclude

Methods inherited from class java.lang.Object

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

Constructor Detail

BestInAlloySystemFilter

public BestInAlloySystemFilter()

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

setNPerDiagram

public void setNPerDiagram(int NPerDiagram)
                    throws java.lang.Exception

Set number of entries to collect per diagram

Parameters:

NPerDiagram - Desired number of entries

Throws:

java.lang.Exception

setRanker

public void setRanker(BaseEntryRanker Ranker)

Set how to rank entries

Parameters:

Ranker - Ranker to use to score entries

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

parallelMinimum

protected int parallelMinimum()

Description copied from class: BaseDatasetFilter

Minimum number of entries to label in parallel.

Overrides:

parallelMinimum in class BaseDatasetFilter

Returns:

Implementer-specified minimum threshold

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