msm_pairwise_distance¶
- msm_pairwise_distance(X: ndarray | list[ndarray], y: ndarray | list[ndarray] | None = None, window: float | None = None, independent: bool = True, c: float = 1.0, itakura_max_slope: float | None = None) ndarray [source]¶
Compute the msm pairwise distance between a set of time series.
- Parameters:
- Xnp.ndarray or List of np.ndarray
A collection of time series instances of shape
(n_cases, n_timepoints)
or(n_cases, n_channels, n_timepoints)
.- ynp.ndarray or List of np.ndarray or None, default=None
A single series or a collection of time series of shape
(m_timepoints,)
or(m_cases, m_timepoints)
or(m_cases, m_channels, m_timepoints)
. If None, then the msm pairwise distance between the instances of X is calculated.- windowfloat, default=None
The window to use for the bounding matrix. If None, no bounding matrix is used.
- independentbool, default=True
Whether to use the independent or dependent MSM distance. The default is True (to use independent).
- cfloat, default=1.
Cost for split or merge operation. Default is 1.
- itakura_max_slopefloat, default=None
Maximum slope as a proportion of the number of time points used to create Itakura parallelogram on the bounding matrix. Must be between 0. and 1.
- Returns:
- np.ndarray (n_cases, n_cases)
msm pairwise matrix between the instances of X.
- Raises:
- ValueError
If X is not 2D or 3D array when only passing X. If X and y are not 1D, 2D or 3D arrays when passing both X and y.
Examples
>>> import numpy as np >>> from aeon.distances import msm_pairwise_distance >>> # Distance between each time series in a collection of time series >>> X = np.array([[[1, 2, 3]],[[4, 5, 6]], [[7, 8, 9]]]) >>> msm_pairwise_distance(X) array([[ 0., 8., 12.], [ 8., 0., 8.], [12., 8., 0.]])
>>> # Distance between two collections of time series >>> X = np.array([[[1, 2, 3]],[[4, 5, 6]], [[7, 8, 9]]]) >>> y = np.array([[[11, 12, 13]],[[14, 15, 16]], [[17, 18, 19]]]) >>> msm_pairwise_distance(X, y) array([[16., 19., 22.], [13., 16., 19.], [10., 13., 16.]])
>>> X = np.array([[[1, 2, 3]],[[4, 5, 6]], [[7, 8, 9]]]) >>> y_univariate = np.array([11, 12, 13]) >>> msm_pairwise_distance(X, y_univariate) array([[16.], [13.], [10.]])
>>> # Distance between each TS in a collection of unequal-length time series >>> X = [np.array([1, 2, 3]), np.array([4, 5, 6, 7]), np.array([8, 9, 10, 11, 12])] >>> msm_pairwise_distance(X) array([[ 0., 10., 17.], [10., 0., 14.], [17., 14., 0.]])