Skip to main content

docs

Documentation Status

tests

GitHub Actions Build Status

package

PyPI - Downloads Conda Downloads

development

GitHub License GitHub last commit Commits since latest release Pixi Badge

This Python package provides a comprehensive set of tools and advanced algorithms for analyzing 3D motion capture data. It is specifically designed to process gait data stored in c3d format. Prior to utilizing the features of gaitalytics, it is necessary to perform data labeling, modeling, and filtering procedures.

The library’s versatility allows it to be adaptable to various marker sets and modeling algorithms, offering high configurability.

Quickstart

Installation

Fast install with anaconda:

conda install gaitalytics -c DartLab-LLUI

Or with pip:

pip install gaitalytics

Configuration

Gaitalytics can be used with any marker set, which at least includes three or four hip markers (front left/right, back left/right or sacrum) and four foot markers (left heel/toe, right heel/toe).

Additionally markers can be defined on which standard time-series features such as min max mean etc. will be calculated.

All functionalities in the libraries only take points into account which are configured in as specific yaml file.

Minimal requirements would look like this:

analysis:
  markers:
    - "LHipAngles"
    - "LKneeAngles"
    - "LAnkleAngles"
    - "LPelvisAngles"
    - "LThoraxAngles"
mapping:
  markers:
    # Foot
    l_heel: "LHEE"
    r_heel: "RHEE"
    l_toe: "LTOE"
    r_toe: "RTOE"

    # Hip
    l_ant_hip: "LASI"
    r_ant_hip: "RASI"
    l_post_hip: "LPSI"
    r_post_hip: "RPSI"
    sacrum: "SACR"

Simple Pipeline

from gaitalytics import api
# Load configuration (yaml file from above)
config = api.load_config("./pig_config.yaml")

# Load trial from c3d file
trial = api.load_c3d_trial("./test_small.c3d", config)

# Detect events
events = api.detect_events(trial, config)
try:
    # check events
    api.check_events(events)

    # write events to c3d in the same file
    api.write_events_to_c3d("./test_small.c3d", events, './test.c3d')

    # add events to trial
    trial.events = events

    # segment trial to gait cycles. (Events are already existing in the c3d file)
    trial_segmented = api.segment_trial(trial)

    # calculate features
    features = api.calculate_features(trial_segmented, config)

    # normalise time
    trial_normalized = api.time_normalise_trial(trial_segmented)

    # save features
    features.to_netcdf("features.nc")

    # export segmented trial to netcdf
    api.export_trial(trial_segmented, "output_segments")
    api.export_trial(trial_normalized, "output_norm")

except ValueError as e:
    print(e)

Documentation

https://python-gaitalytics.readthedocs.org

https://github.com/DART-Lab-LLUI/python-gaitalytics

https://pypi.org/project/gaitalytics/

https://anaconda.org/dartlab-llui/gaitalytics

Metadata

Release files for gaitalytics 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gaitalytics 0.2.2
File Size Uploaded Provenance
gaitalytics-0.2.2.tar.gz 5.7 MB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for gaitalytics 0.2.2
File Interpreter ABI Platform
gaitalytics-0.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 5.7 MB

Release files / gaitalytics-0.2.2.tar.gz

Download URL gaitalytics-0.2.2.tar.gz
Size 5.7 MB
Tags Source
SHA-256 checksum
How to use checksums
02fa69ade972c3d94c29796a090da7aa052d911d704184e732045c27f8a9409d
BLAKE2b-256 checksum
How to use checksums
60c60fa57b48facab7ca500827da4d136814640c78d967f5ccac9c614916aca9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 7, 2025.

Transparency log

Release files / gaitalytics-0.2.2-py3-none-any.whl

Download URL gaitalytics-0.2.2-py3-none-any.whl
Size 31.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e45698fd0a29e455b7a00255299da591d219744d6a6600e426d7674f4cc8021e
BLAKE2b-256 checksum
How to use checksums
42c3d844cd387586c71fd15c3e2ecb1ba48c446bd8131d5ee02af96b469b4722
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 7, 2025.

Transparency log

Security for gaitalytics 0.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for gaitalytics-0.2.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Feb 7, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.2 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page