magpie.data.utilities.filters

Class PropertyFilter

java.lang.Object

magpie.data.utilities.filters.BaseDatasetFilter

magpie.data.utilities.filters.ComparisonOperatorFilter

magpie.data.utilities.filters.AttributeFilter

magpie.data.utilities.filters.PropertyFilter

All Implemented Interfaces:

java.io.Serializable, Options

public class PropertyFilter
extends AttributeFilter

Filter entries based on a measured or predicted property. Requires the data to extend MultiPropertyDataset.

Usage: <measured|predicted> <Target Property> <Criteria> <Threshold>
measured|predicted: Whether to use the measured or predicted value
Target Property: Property on which data is filtered
Criteria: Comparison operator used to filter data. Can be: <, ≤, >, ≥, =, and ≠
Threshold: Value to which property is compared

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	UseMeasured Whether to use measured or predicted property values

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

TargetAttribute

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

Equal, GreaterThan, LessThan, Threshold

Constructor Summary

Constructors

Constructor and Description
PropertyFilter()

Method Summary

Modifier and Type	Method and Description
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> OptionsObj) Set any options for this object.

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

setOptions, setTargetAttribute, train

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

setComparisonOperator, setThreshold, testCriteria

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

UseMeasured

protected boolean UseMeasured

Whether to use measured or predicted property values

Constructor Detail

PropertyFilter

public PropertyFilter()

Method Detail

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.

Specified by:

setOptions in interface Options

Overrides:

setOptions in class AttributeFilter

Parameters:

OptionsObj - 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: ".

Specified by:

printUsage in interface Options

Overrides:

printUsage in class AttributeFilter

Returns:

Usage for this function

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 AttributeFilter

Parameters:

D - Dataset to be labeled

Returns:

A list of booleans marking whether an entry passes