unscale#

pypillometry.unscale(variables=[], center=None, scale=None, eyes=[])#

Pipeline step for unscale() (d | pp.unscale(...)).

Scale back to original values using either values provided as arguments or the values stored in params[“scale”] by scale().

The signal is multiplied by scale and center is added. The stored parameters of the unscaled channels are removed.

Parameters:

  • variables (str or list of str, optional) – variables to unscale; can be “pupil”, “x”,”y”, “baseline”, “response” or any other variable that is available in the dataset; either a string or a list of strings; available variables can be checked with obj.variables; empty list means all variables

  • center (None, float or dict, optional) – value to add to the signal; a number (same for all eyes and variables) or {"left_pupil": value, ...}; if None, use the value stored by scale()

  • scale (None, float or dict, optional) – value to multiply the signal with; a number (same for all eyes and variables) or {"left_pupil": value, ...}; if None, use the value stored by scale()

  • eyes (str or list of str, optional) – eye(s) to consider; if empty, all available eyes

  • inplace (bool or None, optional) – if True, make change in-place and return the object; if False, make and return copy before making changes; if None, use the object-level setting (specified in the constructor)

Return type:

EyeData

Returns:

the unscaled object (self or a copy, depending on inplace)