magpie.data.utilities.modifiers

Class ErrorSignalModifier

java.lang.Object

magpie.data.utilities.modifiers.BaseDatasetModifier

magpie.data.utilities.modifiers.ErrorSignalModifier

All Implemented Interfaces:

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

public class ErrorSignalModifier
extends BaseDatasetModifier

Subtract the predicted class from a dataset, leaving only the error signal as the measured class variable. Only works with regression models.

For MultiPropertyDatasets, adds a new property: ErrorSignal

Usage: $<model> <absolute|relative>
model: Model to use to generate error signal
absolute|relative: Whether to use absolute or relative error

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ErrorSignalModifier()

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	setModel(BaseModel Model) Set the model used to make predictions.
void	setOptions(java.util.List Options) Set any options for this object.
void	useAbsoluteError() Set filter to compute absolute error.
void	useRelativeError() Set filter to computer relative error.

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

ErrorSignalModifier

public ErrorSignalModifier()

Method Detail

setOptions

public void setOptions(java.util.List 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

useAbsoluteError

public void useAbsoluteError()

Set filter to compute absolute error.

useRelativeError

public void useRelativeError()

Set filter to computer relative error.

setModel

public void setModel(BaseModel Model)

Set the model used to make predictions. Must be trained.

Parameters:

Model - Link to a model (will be cloned)

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