magpie.data.utilities.modifiers

Class ClassEliminationModifier

java.lang.Object

magpie.data.utilities.modifiers.BaseDatasetModifier

magpie.data.utilities.modifiers.ClassEliminationModifier

All Implemented Interfaces:

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

public class ClassEliminationModifier
extends BaseDatasetModifier

Remove a possible class from a dataset. Either changes all entries with that are measured to have undesired class to a different one (ex: semiconductor -> nonmetal) or removes those entries.

Example: If you have a dataset where each entry is measured to be either a metal, semiconductor, or insulator and want to only have a "metal" and "nonmetal" class, you could use this entry to change all entries marked as a semiconductor to be insulator.

Usage: <undesired class> [<new class>]
undesired class: Name of class to be removed
new class: Measurements corresponding to undesired class will be changed to this

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassEliminationModifier()

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	setClassToEliminate(java.lang.String classToEliminate) Define the name of the class to eliminate.
void	setNewClassName(java.lang.String newClassName) Define the name of the new class for entries measured to exist in the undesired class.
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

ClassEliminationModifier

public ClassEliminationModifier()

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

setClassToEliminate

public void setClassToEliminate(java.lang.String classToEliminate)

Define the name of the class to eliminate.

Parameters:

classToEliminate - Name of undesired class

setNewClassName

public void setNewClassName(java.lang.String newClassName)

Define the name of the new class for entries measured to exist in the undesired class. Set to "null" to just delete those entries.

Parameters:

newClassName - New class value (null to delete)

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