transform()

ShiftTransformer.transform(states, inplace: bool = False)

Apply the shift.

Parameters:

states(n, …) ndarray

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

inplacebool

If True, overwrite states during transformation. If False, create a copy of the data to transform.

Returns:

states_shifted: (n, …) ndarray

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

Raises:

ValueError

If the states do not align with the state_dimension.