childmindresearch / wristpy

https://childmindresearch.github.io/wristpy/
GNU Lesser General Public License v2.1
2 stars 1 forks source link

Task: Implement euclidean_norm in metrics.py #22

Closed frey-perez closed 3 months ago

frey-perez commented 3 months ago

Description

The goal is to implement a function that will calculate the value of ENMO (Euclidean Norm Minus One) from 3 dimensional accelerometer data. As the name suggests the metric is the Euclidean norm of the 3D acceleration signal minus 1g(1 standard gravity). As a measurement of physical activity, ENMO is one of the key metrics calculated by wristpy and ggir and is of high scientific interest in the fields of actigraphy and sleep research.

The input of the function will be a Measurement object containing the acceleration data(an np array) and timestamps(a polars series) the function will output another Measurement object where the measurement will be the ENMO values at corresponding timestamps.

Tasks

Freeform Notes

No response

Asanto32 commented 3 months ago

Technically we don't need the time data for the ENMO calculation. Would only need it to get epoch level ENMO. Maybe rephrase to say time is unmodified (as a practice for task precision writing?)

frey-perez commented 3 months ago

Technically we don't need the time data for the ENMO calculation. Would only need it to get epoch level ENMO. Maybe rephrase to say time is unmodified (as a practice for task precision writing?)

Good point! it was implicit in my head but I'll make that clear.