tslearn.metrics.lcss¶
- tslearn.metrics.lcss(s1, s2, eps=1.0, global_constraint=None, sakoe_chiba_radius=None, itakura_max_slope=None, be=None)[source]¶
Compute the Longest Common Subsequence (LCSS) similarity measure between (possibly multidimensional) time series and return the similarity.
LCSS is computed by matching indexes that are met up until the eps threshold, so it leaves some points unmatched and focuses on the similar parts of two sequences. The matching can occur even if the time indexes are different. One can set additional constraints to the set of acceptable paths: the Sakoe-Chiba band which is parametrized by a radius or the Itakura parallelogram which is parametrized by a maximum slope. Both these constraints consists in forcing paths to lie close to the diagonal. To retrieve a meaningful similarity value from the length of the longest common subsequence, the percentage of that value regarding the length of the shortest time series is returned.
According to this definition, the values returned by LCSS range from 0 to 1, the highest value taken when two time series fully match, and vice-versa. It is not required that both time series share the same size, but they must be the same dimension. LCSS was originally presented in [1] and is discussed in more details in our dedicated user-guide page.
- Parameters:
- s1array-like, shape=(sz1, d) or (sz1,)
A time series. If shape is (sz1,), the time series is assumed to be univariate.
- s2array-like, shape=(sz2, d) or (sz2,)
Another time series. If shape is (sz2,), the time series is assumed to be univariate.
- epsfloat (default: 1.)
Maximum matching distance threshold.
- global_constraint{“itakura”, “sakoe_chiba”} or None (default: None)
Global constraint to restrict admissible paths for LCSS.
- sakoe_chiba_radiusint or None (default: None)
Radius to be used for Sakoe-Chiba band global constraint. The Sakoe-Chiba radius corresponds to the parameter \(\delta\) mentioned in [1], it controls how far in time we can go in order to match a given point from one time series to a point in another time series. If None and global_constraint is set to “sakoe_chiba”, a radius of 1 is used. If both sakoe_chiba_radius and itakura_max_slope are set, global_constraint is used to infer which constraint to use among the two. In this case, if global_constraint corresponds to no global constraint, a RuntimeWarning is raised and no global constraint is used.
- itakura_max_slopefloat or None (default: None)
Maximum slope for the Itakura parallelogram constraint. If None and global_constraint is set to “itakura”, a maximum slope of 2. is used. If both sakoe_chiba_radius and itakura_max_slope are set, global_constraint is used to infer which constraint to use among the two. In this case, if global_constraint corresponds to no global constraint, a RuntimeWarning is raised and no global constraint is used.
- beBackend object or string or None
Backend. If be is an instance of the class NumPyBackend or the string “numpy”, the NumPy backend is used. If be is an instance of the class PyTorchBackend or the string “pytorch”, the PyTorch backend is used. If be is None, the backend is determined by the input arrays. See our dedicated user-guide page for more information.
- Returns:
- float
Similarity score
See also
lcss_path
Get both the matching path and the similarity score for LCSS
References
Examples
>>> lcss([1, 2, 3], [1., 2., 2., 3.]) 1.0 >>> lcss([1, 2, 3], [1., 2., 2., 4., 7.]) 1.0 >>> lcss([1, 2, 3], [1., 2., 2., 2., 3.], eps=0) 1.0 >>> lcss([1, 2, 3], [-2., 5., 7.], eps=3) 0.6666666666666666