The IDLmlLinearNormalizer class implements a linear normalizer using the formula dataOut = dataIn * scale + offset.

Example


Data = findgen(10)
Normalizer = IDLmlLinearNormalizer(SCALE=2.0, OFFSET=10)
Print, Normalizer.Normalize(data)

Syntax


Result = IDLmlLinearNormalizer([, Properties=value])

Arguments


None

Keywords


None

Properties


SCALE

A scalar or a 1D array of numbers representing the scale factor for the normalization.

OFFSET

A scalar or a 1D array of numbers representing the offsets for the normalization.

Methods


IDLmlLinearNormalizer::Normalize


The IDLmlLinearNormalizer::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->[IDLmlLinearNormalizer::]Normalize, Data

As a function:

Result = Obj->[IDLmlLinearNormalizer::]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

IDLmlLinearNormalizer::Restore


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

Syntax


Result = IDLmlLinearNormalizer.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

IDLmlLinearNormalizer::Save


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

Syntax


Obj->[IDLmlLinearNormalizer::]Save, Filename

Arguments


Filename

Specify the name of the file to save.

Keywords


None

IDLmlLinearNormalizer::Unnormalize


The IDLmlLinearNormalizer::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->[IDLmlLinearNormalizer::]Unnormalize, Data

As a function:

Result = Obj->[IDLmlLinearNormalizer::]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


IDLmlRangeNormalizer, IDLmlTanHNormalizer, IDLmlUnitNormalizer, IDLmlVarianceNormalizer