Skip to main content

micromotion

tests docs PyPI Python License

Analysis of human micromotion in motion time series: optical marker data, body-worn accelerometers, respiration belts and force plates.

The measure the package exists for is quantity of motion — the average speed of a body part, band-limited to 0.2–5 Hz, in millimetres per second. It applies equally to all three sensor families because the shared abstraction is the frequency band, not the instrument.

pip install micromotion
import micromotion as mm

rec  = mm.read("Standstill2017/mocap_data/A0001.tsv")   # dispatches on content, not extension
head = rec.marker("P01")
mm.qom(head, rec.fs, kind="position").mean_mm_s

Documentation

Reference documentation how to use it, every function, the conventions
Wiki why it works this way — traps, recipes, open questions
Changelog what changed, and why

New to it: Getting started, then The two bands, which is the one convention you cannot skip.

Reading files is its own subject, because the formats in this field lie about themselves: Reading files covers what each reader handles, which axis is vertical in which system, and the traps that produce plausible numbers rather than errors — a Y/Z axis swap that reverses every sway direction while leaving magnitudes intact, a Unicode minus that turns negative values into NaN, an app whose clock stops when the phone sleeps.

What is in it

Module Contents
qom quantity of motion from position or acceleration
filters the band definitions, band-pass, low-pass, high-pass, cardiac notch
resample rate measurement, downsample-only resampling, irregular-to-regular gridding
validate checks that fail loudly on silently-wrong data
posture, balance sway geometry, centre-of-pressure measures
spectral, physio cardiac and respiratory peaks, band power, breathing rate
dynamics DFA, multifractality, recurrence, surrogates, entropy
group whether these people moved at the same moments
align, circular offsets between clocks; directional statistics
io, record one reader per corpus layout, a content sniffer, a common record type

Readers: Qualisys and Qualisys-style TSV in all three header shapes, Sverm, Axivity AX3, Physics Toolbox phone logs (raw app export or cleaned), Equivital, Wii balance board, Artinis fNIRS. read dispatches on content rather than extension, because in this corpus the extension is frequently wrong.

Why it exists

It was built while constructing a single analysis across every dataset in the Oslo Standstill Database. There were 159 analysis scripts, of which 58 defined their own band-pass filter and 37 computed quantity of motion. The project's central measure existed in dozens of copies that did not all agree, and the disagreements were invisible.

Every default here was measured rather than assumed, and the reasoning is kept beside it. The traps page lists the mistakes that shaped the design; each one happened, produced a believable wrong number, and raised nothing at the time.

Requirements

Python 3.10+, numpy, scipy, pandas.

Licence

GPL-3.0-or-later. If you use it, please cite it — see CITATION.cff.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

micromotion-0.12.3.tar.gz (155.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

micromotion-0.12.3-py3-none-any.whl (96.0 kB view details)

Uploaded Python 3

File details

Details for the file micromotion-0.12.3.tar.gz.

File metadata

  • Download URL: micromotion-0.12.3.tar.gz
  • Upload date:
  • Size: 155.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for micromotion-0.12.3.tar.gz
Algorithm Hash digest
SHA256 b8c64fb4acc7400ef03d3c34b344da7f2c1550ba3ecd161e60924bde22e7d769
MD5 4b21b3b387a9ddecab3c4dbaf0f9116a
BLAKE2b-256 8452ae5322cae3d0f462da63bff4d51f2e8d54287891c762ae87f1aa678a624a

See more details on using hashes here.

Provenance

The following attestation bundles were made for micromotion-0.12.3.tar.gz:

Publisher: publish.yml on fourMs/micromotion

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file micromotion-0.12.3-py3-none-any.whl.

File metadata

  • Download URL: micromotion-0.12.3-py3-none-any.whl
  • Upload date:
  • Size: 96.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for micromotion-0.12.3-py3-none-any.whl
Algorithm Hash digest
SHA256 07dd0fe1813f0465ad95db00b84d9a655f8944c0ce45aba188ddb317e335d968
MD5 352fe7b91761c131e109e6c4f1369498
BLAKE2b-256 9e7f3abf608c159cad593a1c5b89dc15bc9969c26254fa5ce303391cbe38d62b

See more details on using hashes here.

Provenance

The following attestation bundles were made for micromotion-0.12.3-py3-none-any.whl:

Publisher: publish.yml on fourMs/micromotion

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page