magpie.data.utilities.filters

Class ContainsElementFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.ContainsElementFilter

All Implemented Interfaces:

java.io.Serializable, Options

Direct Known Subclasses:

PhaseDiagramExclusionFilter

public class ContainsElementFilter
extends BaseDatasetFilter

Filter entries that contain certain elements. Only works on CompositionDataset.

Usage: <Element names...>
Element names...: Entries containing these elements pass the filter

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	ElementList Elements that compounds are not allowed to contain
protected int[]	ExcludedIndex List of IDs of those elements

Constructor Summary

Constructors

Constructor and Description
ContainsElementFilter()

Method Summary

Modifier and Type	Method and Description
boolean	entryContainsElement(CompositionEntry entry) Determine whether an entry contains one of the specified elements.
protected static int[]	getElementIndices(java.lang.String[] ElementList) Given a list of elements, return their indices.
boolean[]	label(Dataset D) Given a dataset, determine which entries passes the filter.
java.lang.String	printUsage() Print out required format for options.
void	setElementList(java.lang.String[] elements) Define list of elements to use for filter.
void	setElementListByIndex(int[] elements) Define a list of elements to use for the filter
void	setOptions(java.util.List<java.lang.Object> OptionsObj) 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

ElementList

protected java.lang.String[] ElementList

Elements that compounds are not allowed to contain

ExcludedIndex

protected int[] ExcludedIndex

List of IDs of those elements

Constructor Detail

ContainsElementFilter

public ContainsElementFilter()

Method Detail

getElementIndices

protected static int[] getElementIndices(java.lang.String[] ElementList)

Given a list of elements, return their indices.

Parameters:

ElementList - List of element names to operate on

Returns:

Array containing index of each element in ElementList

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

setElementList

public void setElementList(java.lang.String[] elements)

Define list of elements to use for filter.

Parameters:

ElementList - List of element abbreviations

setElementListByIndex

public void setElementListByIndex(int[] elements)

Define a list of elements to use for the filter

Parameters:

elements - Index of the elements

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

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

entryContainsElement

public boolean entryContainsElement(CompositionEntry entry)

Determine whether an entry contains one of the specified elements.

Parameters:

entry - Entry in question

Returns:

Whether it contains at least one of the specified elements