---

Time Series Subsequence Search Library

Intuitive time series subsequence search

This repository hosts the TSSEARCH - Time Series Subsequence Search Python package. TSSEARCH assists researchers in exploratory analysis for query search and time series segmentation without requiring significant programming effort.

Functionalities

• Search: We provide methods for time series query search and segmentation
• Weights: The relative contribution of each point of the query to the overall distance can be expressed using a user-defined weight vector.
• Visualization: We provide visualizations to present the results of the segmentation and query search
• Unit tested: we provide unit tests for each feature
• Easily extended: adding new distances is easy, and we encourage you to contribute with your custom distances or search methods

Get started

⚙️ Installation

TSSEARCH supports Python 3.8 or greater. You can easily install via PyPI:

pip install tssearch

Example

The code below segments a 10 s electrocardiography record:

import tssearch

# Load the query, (optional) weight vector and sequence
data = tssearch.load_ecg_example()

# Selects the Dynamic Time Warping (DTW) as the distance for the segmentation
cfg = tssearch.get_distance_dict(["Dynamic Time Warping"])

# Performs the segmentation
out = tssearch.time_series_segmentation(cfg, data['query'], data['sequence'], data['weight'])

Documentation

The documentation is available here.

Available distances

Lockstep
Lp Distances
Pearson Correlation Distance
Short Time Series Distance (STS)

Elastic
Dynamic Time Warping (DTW)
Longest Common Subsequence (LCSS)
Time Warp Edit Distance (TWED)

Time
Time Alignment Measurement (TAM)

Citing

When using TSSEARCH please cite the following publication:

Folgado, Duarte and Barandas, Marília, et al. "TSSEARCH: Time Series Subsequence Search Library" SoftwareX 11 (2022). https://doi.org/10.1016/j.softx.2022.101049

Acknowledgements

This work is a result of the project ConnectedHealth (n.º 46858), supported by Competitiveness and Internationalisation Operational Programme (POCI) and Lisbon Regional Operational Programme (LISBOA 2020), under the PORTUGAL 2020 Partnership Agreement, through the European Regional Development Fund (ERDF)