com.emphysic.myriad.core.data.ops

Class ScalingOperation

java.lang.Object

com.emphysic.myriad.core.data.ops.ScalingOperation

All Implemented Interfaces:

DatasetOperation, ObjectMap, com.esotericsoftware.kryo.KryoSerializable

public class ScalingOperation
extends java.lang.Object
implements DatasetOperation

ScalingOperation - scales a Dataset by substracting its mean and dividing by the standard deviation. Differs from FeatureScalingOperation in that ScalingOperation is per-Dataset while FeatureScalingOperation scales across Datasets by feature (index position in the Dataset's underlying array).

Constructor Summary

Constructors

Constructor and Description
ScalingOperation() Initializes a new ScalingOperation.
ScalingOperation(double mean, double std) Creates a new ScalingOperation with the specified mean and standard deviation.

Method Summary

Modifier and Type	Method and Description
double	getMean() Returns the mean value used in normalization.
java.util.Map<java.lang.String,java.lang.Object>	getObjectMap() Creates a map of the important fields for the instance, suitable for serialization.
long	getSerializationVersion() Returns the current version of the serialization format.
double	getStd() Returns the standard deviation used in normalization.
int	getVersion() Returns the current class version.
void	initCurrentVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap) Initializes an instance with a current-version object graph.
Dataset	run(Dataset input) Scales an input Dataset
void	setMean(double mean) Sets the mean value used in normalization.
void	setStd(double std) Sets the standard deviation used in normalization.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.emphysic.myriad.core.data.util.ObjectMap

init, initPreviousVersion, initUnknownVersion, load, read, save, write

Constructor Detail

ScalingOperation

public ScalingOperation(double mean,
                        double std)

Creates a new ScalingOperation with the specified mean and standard deviation.

Parameters:

mean - mean

std - standard deviation

ScalingOperation

public ScalingOperation()

Initializes a new ScalingOperation. Mean and standard deviation are calculated from the input Dataset.

Method Detail

run

public Dataset run(Dataset input)

Scales an input Dataset

Specified by:

run in interface DatasetOperation

Parameters:

input - Dataset on which to operate

Returns:

scaled Dataset, or null if input was null.

getMean

public double getMean()

Returns the mean value used in normalization.

Returns:

mean value

setMean

public void setMean(double mean)

Sets the mean value used in normalization.

Parameters:

mean - mean value

getStd

public double getStd()

Returns the standard deviation used in normalization.

Returns:

standard deviation

setStd

public void setStd(double std)

Sets the standard deviation used in normalization.

Parameters:

std - standard deviation.

getSerializationVersion

public long getSerializationVersion()

Description copied from interface: ObjectMap

Returns the current version of the serialization format. Increments when the serialization format changes, i.e. backwards compatibility is broken.

Specified by:

getSerializationVersion in interface ObjectMap

Returns:

serialization version

getVersion

public int getVersion()

Description copied from interface: ObjectMap

Returns the current class version. Class version increments when the class changes but doesn't necessarily break compatibility with serialization.

Specified by:

getVersion in interface ObjectMap

Returns:

class version

getObjectMap

public java.util.Map<java.lang.String,java.lang.Object> getObjectMap()

Description copied from interface: ObjectMap

Creates a map of the important fields for the instance, suitable for serialization.

Specified by:

getObjectMap in interface ObjectMap

Returns:

"object map" of the instance

initCurrentVersion

public void initCurrentVersion(java.util.Map<java.lang.String,java.lang.Object> objectMap)

Description copied from interface: ObjectMap

Initializes an instance with a current-version object graph.

Specified by:

initCurrentVersion in interface ObjectMap

Parameters:

objectMap - object graph for initialization