The IDLmlVarianceNormalizer class implements a normalizer that will scale data to have a mean of 0 and a standard deviation of 1, regardless of range.

Example


Data = findgen(10)
Normalizer = IDLmlVarianceNormalizer(data)
Print, Normalizer.Normalize(data)

Syntax


Result = IDLmlVarianceNormalizer(Data)

Arguments


Data

A numerical array from which the normalizer will determine the proper normalization parameters. The array must be 2D, of size n x m, where n is the number of attributes and m is the number of examples.

Keywords


None

Properties


None

Methods


IDLmlVarianceNormalizer::Normalize


The IDLmlVarianceNormalizer::Normalize method computes the normalization of input data.

Syntax


This method can be invoked as a procedure or a function. The procedure syntax is faster and more efficient, but it overwrites the Data argument. The function syntax is less efficient, but it leaves the input argument untouched.

As a procedure:

Obj->[IDLmlVarianceNormalizer::]Normalize, Data

As a function:

Result = Obj->[IDLmlVarianceNormalizer::]Normalize(Data)

Return Value


If called as a procedure, the normalized array will overwrite the input Data argument. If called as a function, the return value will be an array with the same dimensions as Data, which contains the normalized result.

Arguments


Data

Specify a scalar, 1D array or 2D array of data to normalize.

If the data is 2D, the array must be of size n x m, where n is the number of attributes and m is the number of examples. If the data is 1D, the array must be of size n (number of attributes).

Keywords


None

IDLmlVarianceNormalizer::Restore


The IDLmlVarianceNormalizer::Restore static method restores the normalizer from a file.

Syntax


Result = IDLmlVarianceNormalizer.Restore(Filename)

Return Value


A reference to the object instance restored from the file.

Arguments


Filename

Specify the name of the file to restore.

Keywords


None

IDLmlVarianceNormalizer::Save


The IDLmlVarianceNormalizer::Save method saves the normalizer to a file.

Syntax


Obj->[IDLmlVarianceNormalizer::]Save, Filename

Arguments


Filename

Specify the name of the file to save.

Keywords


None

IDLmlVarianceNormalizer::Unnormalize


The IDLmlVarianceNormalizer::Unnormalize method returns normalized data to its original values.

Syntax


This method can be invoked as a procedure or a function. The procedure syntax is faster and more efficient, but it overwrites the Data argument. The function syntax is less efficient, but it leaves the input argument untouched.

As a procedure:

Obj->[IDLmlVarianceNormalizer::]Unnormalize, Data

As a function:

Result = Obj->[IDLmlVarianceNormalizer::]Unnormalize(Data)

Return Value


If called as a procedure, the unnormalized array will overwrite the input Data argument. If called as a function, the return value will be an array with the same dimensions as Data, which contains the unnormalized result.

Arguments


Data

Specify a scalar, 1D array or 2D array of data to normalize.

If the data is 2D, the array must be of size n x m, where n is the number of attributes and m is the number of examples. If the data is 1D, the array must be of size n (number of attributes).

Keywords


None

Version History


8.7.1

Introduced

See Also


IDLmlLinearNormalizer, IDLmlRangeNormalizer, IDLmlTanHNormalizer, IDLmlUnitNormalizer