magpie.data.utilities.modifiers

Class HHICalculationModifier

java.lang.Object

magpie.data.utilities.modifiers.BaseDatasetModifier

magpie.data.utilities.modifiers.HHICalculationModifier

All Implemented Interfaces:

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

public class HHICalculationModifier
extends BaseDatasetModifier

Calculates the Herfindahl-Hirschman Index (HHI) for compounds, stores as property. Uses data from the Materials Research Laboratory at UCSB, and computes the HHI value as the maximum HHI_p of any element present. Smaller HHI_p values indicate materials that are more economically-feasible to produce

This property is added to the dataset and all entries it contains. Both the measured and predicted values of this property are set since it is something that is not intended to predicted by a model. Results are stored as the property HHI.

Usage: *No options*

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HHICalculationModifier()

Method Summary

Modifier and Type	Method and Description
protected void	modifyDataset(Dataset Data) Apply changes to the Dataset.
java.lang.String	printUsage() Print out required format for options.
void	setOptions(java.util.List<java.lang.Object> Options) Set any options for this object.

Methods inherited from class magpie.data.utilities.modifiers.BaseDatasetModifier

transform

Methods inherited from class java.lang.Object

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

Constructor Detail

HHICalculationModifier

public HHICalculationModifier()

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

modifyDataset

protected void modifyDataset(Dataset Data)

Description copied from class: BaseDatasetModifier

Apply changes to the Dataset. Should modify both each entries and the dataset as a whole.

Specified by:

modifyDataset in class BaseDatasetModifier

Parameters:

Data - Dataset to be modified