inverse_transform()

ShiftTransformer.inverse_transform(states_shifted, inplace=False, locs=None)

Apply the inverse shift.

Parameters:

states_shifted(n, …) or (p, …) ndarray

Matrix of n-dimensional shifted snapshots, or a single shifted snapshot.

inplacebool

If True, overwrite states_shifted during the inverse transformation. If False, create a copy of the data to untransform.

locsslice or (p,) ndarray of integers or None

If given, assume states_shifted contains the transformed snapshots at only the p indices described by locs.

Returns:

states_unshifted: (n, …) or (p, …) ndarray

Matrix of n-dimensional unshifted snapshots, or the p entries of such at the indices specified by locs.

Raises:

ValueError

If the states_shifted do not align with the locs (when provided) or the state_dimension (when locs is not provided).