pingwyn.normalise

Normalise an object. The entire object will be normalised. This means that pingwyn.Grid and pingwyn.Profile types are normalised to their global maximum value, rather than the maximum for each individual curve that make up these types.

param obj:

Object to normalise.

type obj:

pingwyn.Curve or pingwyn.Grid or pingwyn.Image or pingwyn.Profile

param strat:

Normalisation strategy to apply. “minmax” will normalise the object to values between 0 and 1. “vector” will rescale the data to not be larger than 1, but will leave any offset in place.

type strat:

{“minmax”, “vector”}

returns:

obj – Normalised object. Has the same type as the input object.

rtype:

pingwyn.Curve or pingwyn.Grid or pingwyn.Image or pingwyn.Profile