class DMDModel

class deeptime.decomposition.DMDModel(eigenvalues: ndarray, modes: ndarray, mode='exact')

Model produced by the DMD estimator.

Parameters:
  • eigenvalues ((n,) ndarray) – The DMD eigenvalues.

  • modes ((n, n) ndarray) – The DMD modes.

  • mode (str, optional, default='exact') – The mode of estimation that was used. See DMD.available_modes.

Methods

copy()

Makes a deep copy of this model.

get_params([deep])

Get the parameters.

set_params(**params)

Set the parameters of this estimator.

transform(data, **kwargs)

Transforms an input trajectory by applying the model's captured dynamics.

__call__(*args, **kwargs)

Call self as a function.

copy() Model

Makes a deep copy of this model.

Returns:

A new copy of this model.

Return type:

copy

get_params(deep=False)

Get the parameters.

Returns:

params – Parameter names mapped to their values.

Return type:

mapping of string to any

set_params(**params)

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as pipelines). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:

**params (dict) – Estimator parameters.

Returns:

self – Estimator instance.

Return type:

object

transform(data: ndarray, **kwargs)

Transforms an input trajectory by applying the model’s captured dynamics.

Parameters:
  • data ((T, n) ndarray) – Input trajectory

  • **kwargs – Compatibility.

Returns:

output_trajectory

Return type:

(T, n) ndarray