geopard 0.2.2

Matching of gpx segments with dynamic time warping.

geopard

Matching of gpx segments with dynamic time warping.

Description

Pre-processing and analysis of gpx tracks (activities) for comparison to an existing gpx track (gold standard, segment). Checked are the joint start and end points with a given tolerance to trim the activity. Both tracks are interpolated to allow for both curves to be compared with dynamic time warping. Dynamic time warping allows to assess whether the activity actually completed the gold standard segment, and what the shortest required time was (in case of multiple repetitions or many points of the activity within the allowed distance of start and end points).

Setup

Poetry (recommended)

• Poetry is used for the virtual Python environment.

  • Install python poetry:

    curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
    

    or

    pip install --user poetry
    

  • Make sure that the virtual environment is installed in the root folder of this projects:

    poetry config virtualenvs.in-project true
    

  • Install dependencies:

    poetry install --no-root
    

  • Add packages: To add further packages, run:

    poetry add <package-name>
    

pip

Alternatively, install python dependencies with pip:

pip install -r requirements.txt

Code formatting

• Formatting via pre-commit hook: Python code is formatted using pre-commit hooks.

• Install pre-commit:

  pip install pre-commit
  

  or

  brew install pre-commit
  

• Install pre-commit hooks from the config file .pre-commit-config.yaml

  pre-commit install
  

• Run the pre-commit hooks:

  pre-commit run -a
  

Code testing

Testing is done with pytest. The pytest package is already installed in the poetry venv.

• Run all tests:

  pytest
  

• Run individual tests:

  pytest <path-to-test-files>
  

Usage

• Example GPX tracks are available at https://github.com/danielvogler/geopard_tests
• Example files for construction of start/finish region in <PROJECT_ROOT>/data/csv_polygon_files/
• Example usage demonstrated in <PROJECT_ROOT>/geopard_example

Example usage with circular start region around gold start/end points:

import geopard

# initialize
gp = geopard.Geopard()

# dtw matching of example segments/activities
response = gp.dtw_match(gold_name, activity_name)

# optional with:
# min_trkps - minimum number of trackpoints between start and finish
# radius - radius around start and finish of gold segment
# dtw_threshold - segment match quality
response = gp.dtw_match(gold_name, activity_name, min_trkps = 100, radius=15, dtw_threshold=0.3)

# GeopardResponse

# final time
response.time

# final dtw
response.dtw

# final start point
response.start_point

# final end point
response.end_point

# match flag
response.match_flag

# is_success and error
response.is_success
response.error

Example usage with start/finish regions:

import geopard

# initialize
gp = geopard.Geopard()

start_region = gp.create_polygon("<PROJECT_ROOT>/data/csv_polygon_files/example_start_region.csv")
finish_region = gp.create_polygon("<PROJECT_ROOT>/data/csv_polygon_files/example_finish_region.csv")

gold_name = './data/gpx_files/tds_sunnestube_segment.gpx'
activity_name = './data/gpx_files/tds_sunnestube_activity_25_25.gpx'

geopard_response = gp.dtw_match(gold_name, activity_name, start_region=start_region, finish_region=finish_region)

# GeopardResponse
gp.parse_response(geopard_response)

Examples

Example of gold segment, total activity and activity cropped to gold segment length.

Example of start and end points to crop gpx tracks and obtain pairs for dtw matching.