Python package for analyzing sensor-collected human motion data

Last update: Nov 05, 2022

Overview

Installation | Requirements | Usage | Contribution | Getting Help

Sensor Motion

https://readthedocs.org/projects/sensormotion/badge/?version=latest

https://badges.gitter.im/gitterHQ/gitter.png

Python package for analyzing sensor-collected human motion data (e.g. physical activity levels, gait dynamics).

Dedicated accelerometer devices, such as those made by Actigraph, usually bundle software for the analysis of the sensor data. In my work I often collect sensor data from smartphones and have not been able to find any comparable analysis software.

This Python package allows the user to extract human motion data, such as gait/walking dynamics, directly from accelerometer signals. Additionally, the package allows for the calculation of physical activity (PA) or moderate-to-vigorous physical activity (MVPA) counts, similar to activity count data offered by companies like Actigraph.

Installation

You can install this package using pip:

pip install sensormotion

Requirements

This package has the following dependencies, most of which are just Python packages:

Python 3.x
- The easiest way to install Python is using the Anaconda distribution, as it also includes the other dependencies listed below
- Python 2.x has not been tested, so backwards compatibility is not guaranteed
numpy
- Included with Anaconda. Otherwise, install using pip (pip install numpy)
scipy
- Included with Anaconda. Otherwise, install using pip (pip install scipy)
matplotlib
- Included with Anaconda. Otherwise, install using pip (pip install matplotlib)

Usage

Here is brief example of extracting step-based metrics from raw vertical acceleration data:

Import the package:

import sensormotion as sm

If you have a vertical acceleration signal x, and its corresponding time signal t, we can begin by filtering the signal using a low-pass filter:

b, a = sm.signal.build_filter(frequency=10,
                              sample_rate=100,
                              filter_type='low',
                              filter_order=4)

x_filtered = sm.signal.filter_signal(b, a, signal=x)

Next, we can detect the peaks (or valleys) in the filtered signal, which gives us the time and value of each detection. Optionally, we can include a plot of the signal and detected peaks/valleys:

peak_times, peak_values = sm.peak.find_peaks(time=t, signal=x_filtered,
                                             peak_type='valley',
                                             min_val=0.6, min_dist=30,
                                             plot=True)

From the detected peaks, we can then calculate step metrics like cadence and step time:

cadence = sm.gait.cadence(time=t, peak_times=peak_times, time_units='ms')
step_mean, step_sd, step_cov = sm.gait.step_time(peak_times=peak_times)

Physical activity counts and intensities can also be calculated from the acceleration data:

x_counts = sm.pa.convert_counts(x, time, integrate='simpson')
y_counts = sm.pa.convert_counts(y, time, integrate='simpson')
z_counts = sm.pa.convert_counts(z, time, integrate='simpson')
vm = sm.signal.vector_magnitude(x_counts, y_counts, z_counts)
categories, time_spent = sm.pa.cut_points(vm, set_name='butte_preschoolers', n_axis=3)

For a more in-depth tutorial, and more workflow examples, please take a look at the tutorial.

I would also recommend looking over the documentation to see other functionalities of the package.

Contribution

I work on this package in my spare time, on an "as needed" basis for my research projects. However, pull requests for bug fixes and new features are always welcome!

Please see the develop branch for the development version of the package, and check out the issues page for bug reports and feature requests.

Getting Help

You can find the full documentation for the package here

Python's built-in help function will show documentation for any module or function: help(sm.gait.step_time)

You're encouraged to post questions, bug reports, or feature requests as an issue

Alternatively, ask questions on Gitter

Comments

Question

I am using sensormotion.py package for finding peaks for one of my applications. I want to know how normalized min_value (0-1) in peak.find_peaks is related to minimum detectable peak value.

opened by vivekmahadev 2
I need help using this library!

Hi

I'm very interested in using this library in my project. I have a test of 2min walking at 100Hz and I collect the data from accelerometer, gyro and magnetometer of an Iphone 6.

I'm trying to use the library with my data but I could understand some things. For example this function sm.peak.find_peaks(ac_lags, ac, peak_type='peak', min_val= 0.6, min_dist=32, plot=True). What are the suitable values of min_val and min_dist parameters? Are they problem dependent? I have tried with many values and the step estimation is not correct.

Please, could you help me?

Best regards

opened by ogreyesp 1
sm.gait.step_regularity IndexError

step_reg, stride_reg = sm.gait.step_regularity(ac_peak_values) File ".../python3.6/site-packages/sensormotion-1.1.0-py3.6.egg/sensormotion/gait.py", line 128, in step_regularity ac_d2 = peaks_half[2] # second dominant period i.e. a stride (left-left) sm.gait.step_regularity IndexError: index 2 is out of bounds for axis 0 with size 2

opened by jiakang 1
Example: Importing from live cvs file?

Do you have any examples where a 1.) step is to open a demo cvs file, and parse the necessary data to be able to apply your package to the data?

I'm needing help starting from square one.

Android-Go01_MetaWear-01_2022-03-26T11.14.56.138_F5EC5C968CB3_Accelerometer_1.3.6.csv

opened by RandoSY 1
Question about step regularity

Hey, I'm using your package right now to generate features for a dataset. I have looked at the paper by Moe Nilssen et al. and tried to follow the steps for calculating step and stride regularity. However, I wonder why you still do the following calculation at the end:

step_reg = ac_d1 / ac_lag0 stride_reg = ac_d2 / ac_lag0

Can you help me with this?

opened by vanessabin 1

Releases(1.1.4)

1.1.4(Nov 12, 2018)
Code formatting

Source code(tar.gz)
Source code(zip)
1.1.3(Oct 21, 2018)

Added warnings for short signal lengths
Source code(tar.gz)
Source code(zip)
1.1.2(Oct 21, 2018)

Sphinx doc update
Source code(tar.gz)
Source code(zip)
1.1.1(Oct 21, 2018)

Fix pip install from pypi
Source code(tar.gz)
Source code(zip)
1.1.0(Apr 21, 2018)

Added conversion of accelerometer data to physical activity counts and intensities
Source code(tar.gz)
Source code(zip)
1.0.3(Apr 19, 2018)

Drastically improved documentation
Source code(tar.gz)
Source code(zip)
1.0.2(Apr 19, 2018)

Source code(tar.gz)
Source code(zip)
1.0.1(Apr 19, 2018)

Source code(tar.gz)
Source code(zip)
1.0.0(Apr 19, 2018)

Added gait analysis and signal processing
Source code(tar.gz)
Source code(zip)

Owner

Simon Ho

Data Science | Machine Learning | Statistics | Gaming

GitHub Repository

Vectorizers for a range of different data types

69 Dec 29, 2022

An ETL framework + Monitoring UI/API (experimental project for learning purposes)

Fastlane An ETL framework for building pipelines, and Flask based web API/UI for monitoring pipelines. Project structure fastlane |- fastlane: (ETL fr

2 Jan 06, 2022

Approximate Nearest Neighbor Search for Sparse Data in Python!

Approximate Nearest Neighbor Search for Sparse Data in Python! This library is well suited to finding nearest neighbors in sparse, high dimensional spaces (like text documents).

906 Jan 01, 2023

Data collection, enhancement, and metrics calculation.

l3_data_collection Data collection, enhancement, and metrics calculation. Summary Repository containing code for QuantDAO's JDT data collection task.

3 Dec 23, 2022

SparseLasso: Sparse Solutions for the Lasso

SparseLasso: Sparse Solutions for the Lasso Introduction SparseLasso provides a Scikit-Learn based estimation of the Lasso with cross-validation tunin

1 Nov 08, 2021

This is a tool for speculation of ancestral allel, calculation of sfs and drawing its bar plot.

superSFS This is a tool for speculation of ancestral allel, calculation of sfs and drawing its bar plot. It is easy-to-use and runing fast. What you s

3 Dec 16, 2022

Projeto para realizar o RPA Challenge . Utilizando Python e as bibliotecas Selenium e Pandas.

RPA Challenge in Python Projeto para realizar o RPA Challenge (www.rpachallenge.com), utilizando Python. O objetivo deste desafio é criar um fluxo de

1 Apr 12, 2022

Statistical Analysis 📈 focused on statistical analysis and exploration used on various data sets for personal and professional projects.

Statistical Analysis 📈 This repository focuses on statistical analysis and the exploration used on various data sets for personal and professional pr

1 Sep 03, 2022

A crude Hy handle on Pandas library

Quickstart Hyenas is a curde Hy handle written on top of Pandas API to allow for more elegant access to data-scientist's powerhouse that is Pandas. In

4 Sep 05, 2022

Python Package for DataHerb: create, search, and load datasets.

The Python Package for DataHerb A DataHerb Core Service to Create and Load Datasets.

4 Feb 11, 2022

First steps with Python in Life Sciences

First steps with Python in Life Sciences This course material is part of the "First Steps with Python in Life Science" three-day course of SIB-trainin

22 Jan 08, 2023

Time ranges with python

timeranges Time ranges. Read the Docs Installation pip timeranges is available on pip: pip install timeranges GitHub You can also install the latest v

2 Sep 01, 2022

Detailed analysis on fraud claims in insurance companies, gives you information as to why huge loss take place in insurance companies

Insurance-Fraud-Claims Detailed analysis on fraud claims in insurance companies, gives you information as to why huge loss take place in insurance com

1 Jan 27, 2022

Python package for analyzing sensor-collected human motion data

Related tags

Overview

Sensor Motion

Installation

Requirements

Usage

Contribution

Getting Help

Comments

Question

I need help using this library!

sm.gait.step_regularity IndexError

Example: Importing from live cvs file?

Question about step regularity

Releases(1.1.4)

1.1.4(Nov 12, 2018)

1.1.3(Oct 21, 2018)

1.1.2(Oct 21, 2018)

1.1.1(Oct 21, 2018)

1.1.0(Apr 21, 2018)

1.0.3(Apr 19, 2018)

1.0.2(Apr 19, 2018)

1.0.1(Apr 19, 2018)

1.0.0(Apr 19, 2018)

Owner

Simon Ho

Vectorizers for a range of different data types

An ETL framework + Monitoring UI/API (experimental project for learning purposes)

Approximate Nearest Neighbor Search for Sparse Data in Python!

Data collection, enhancement, and metrics calculation.

SparseLasso: Sparse Solutions for the Lasso

This is a tool for speculation of ancestral allel, calculation of sfs and drawing its bar plot.

Projeto para realizar o RPA Challenge . Utilizando Python e as bibliotecas Selenium e Pandas.

Statistical Analysis 📈 focused on statistical analysis and exploration used on various data sets for personal and professional projects.

A crude Hy handle on Pandas library

Python Package for DataHerb: create, search, and load datasets.

First steps with Python in Life Sciences

Time ranges with python

Detailed analysis on fraud claims in insurance companies, gives you information as to why huge loss take place in insurance companies

Numerical Analysis toolkit centred around PDEs, for demonstration and understanding purposes not production

A collection of robust and fast processing tools for parsing and analyzing web archive data.

A notebook to analyze Amazon Recommendation Review Dataset.

An easy-to-use feature store

Program that predicts the NBA mvp based on data from previous years.

This python script allows you to manipulate the audience data from Sl.ido surveys

💬 Python scripts to parse Messenger, Hangouts, WhatsApp and Telegram chat logs into DataFrames.