magpie.data.utilities.filters

Class PhaseDiagramExclusionFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.ContainsElementFilter

magpie.data.utilities.filters.PhaseDiagramExclusionFilter

All Implemented Interfaces:

java.io.Serializable, Options

public class PhaseDiagramExclusionFilter
extends ContainsElementFilter

Filter entries from certain phase diagrams. Removes entries that only contain elements from a certain set and those that contain all elements from that set.

Example: When excluding entries from the Al-Ni phase diagram

1. Al will be removed because it contains Al and no other element
2. AlNi will be removed because it contains both Al and Ni
3. AlZr will not be removed because it contains another element
4. AlNiZr will be removed because it contains both Al and Ni

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

See Also:

Serialized Form

Field Summary

Fields inherited from class magpie.data.utilities.filters.ContainsElementFilter

ElementList, ExcludedIndex

Constructor Summary

Constructors

Constructor and Description
PhaseDiagramExclusionFilter()

Method Summary

Modifier and Type	Method and Description
boolean[]	label(Dataset D) Given a dataset, determine which entries passes the filter.

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

entryContainsElement, getElementIndices, printUsage, setElementList, setElementListByIndex, setOptions, train

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

PhaseDiagramExclusionFilter

public PhaseDiagramExclusionFilter()

Method Detail

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)

Overrides:

label in class ContainsElementFilter

Parameters:

D - Dataset to be labeled

Returns:

A list of booleans marking whether an entry passes