magpie.data.utilities.modifiers

Class ClassIntervalModifier

java.lang.Object

magpie.data.utilities.modifiers.BaseDatasetModifier

magpie.data.utilities.modifiers.ClassIntervalModifier

All Implemented Interfaces:

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

public class ClassIntervalModifier
extends BaseDatasetModifier

Transforms a Dataset with a continuous class variable into a dataset with multiple class based on the value of the class variable. User must define bins that define the new classes, follows the following procedure.

Class ≤ edge0 -> Class = 0
Class > edge0 && Class ≤ edge1 -> Class = 1
...
Class > edgeN -> Class = N

For MultiPropertyDatasets, adds a new property and sets it as the target class.

Usage: <interval edges...>
interval edges...: Values that define edges of class variable bins.

See Also:

MultiPropertyDataset, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassIntervalModifier()

Method Summary

Modifier and Type	Method and Description
protected void	modifyDataset(Dataset Data) Apply changes to the Dataset.
int	NBins() Get number of intervals on which data is split.
java.lang.String	printUsage() Print out required format for options.
void	setEdges(double[] edges) Set the Edges that define the class intervals on which data is discretized.
void	setOptions(java.util.List 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

ClassIntervalModifier

public ClassIntervalModifier()

Method Detail

setEdges

public void setEdges(double[] edges)

Set the Edges that define the class intervals on which data is discretized.

Parameters:

edges - Edges of bins

NBins

public int NBins()

Get number of intervals on which data is split.

Returns:

Number of intervals

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

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