The IDLmlUnitNormalizer class implements a normalizer that will scale data to have a range of 1.

Example


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

Syntax


Result = IDLmlUnitNormalizer(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


IDLmlUnitNormalizer::Normalize


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

As a function:

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

IDLmlUnitNormalizer::Restore


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

Syntax


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

IDLmlUnitNormalizer::Save


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

Syntax


Obj->[IDLmlUnitNormalizer::]Save, Filename

Arguments


Filename

Specify the name of the file to save.

Keywords


None

IDLmlUnitNormalizer::Unnormalize


The IDLmlUnitNormalizer::Unnormalize method computes the actual 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->[IDLmlUnitNormalizer::]Unnormalize, Data

As a function:

Result = Obj->[IDLmlUnitNormalizer::]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, IDLmlVarianceNormalizer