Skip to content

Commit b17268c

Browse files
author
André Böni
committed
+ documentation Usage: Loading
+ documentation Usage: Events + documentation Readme changes
1 parent 70964c7 commit b17268c

File tree

14 files changed

+903
-93
lines changed

14 files changed

+903
-93
lines changed

‎README.rst

Lines changed: 57 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -57,14 +57,14 @@ The library provides a function to load a c3d file into a trial object for usage
5757
Event Detection
5858
^^^^^^^^^^^^^^^
5959

60-
+------------+--------------------------+----------------------------------------------------------------------------+
61-
| Method | Description | options |
62-
+============+==========================+============================================================================+
63-
| Marker | Zeni et al. 2008 [1] | - height: The height of peaks for events. |
64-
| | | - threshold: The threshold for detecting events. |
65-
| | | - distance: The min distance in frames between events. |
66-
| | | - rel_height: The relative height of peak for events. |
67-
+------------+--------------------------+----------------------------------------------------------------------------+
60+
+------------+---------------------------------+----------------------------------------------------------------------------+
61+
| Method | Description | options |
62+
+============+=================================+============================================================================+
63+
| Marker | Zeni et al. 2008 [1]_ | - height: The height of peaks for events. |
64+
| | | - threshold: The threshold for detecting events. |
65+
| | | - distance: The min distance in frames between events. |
66+
| | | - rel_height: The relative height of peak for events. |
67+
+------------+---------------------------------+----------------------------------------------------------------------------+
6868

6969

7070
Event Detection Check
@@ -115,60 +115,40 @@ Currently only linear time normalization is supported.
115115
Feature calculation
116116
^^^^^^^^^^^^^^^^^^^
117117

118-
+-------------------------+-------------------------------------------------------+---------------------------------------+
119-
| Method | Description | options |
120-
+=========================+=======================================================+=======================================+
121-
| TimeSeriesFeatures | - min | |
122-
| | - max | |
123-
| | - mean | |
124-
| | - sd | |
125-
| | - median | |
126-
| | - amplitude | |
127-
+-------------------------+-------------------------------------------------------+---------------------------------------+
128-
| PhaseTimeSeriesFeatures | - stand_min | |
129-
| | - stand_max | |
130-
| | - stand_mean | |
131-
| | - stand_sd | |
132-
| | - stand_median | |
133-
| | - stand_amplitude | |
134-
| | - swing_max | |
135-
| | - swing_mean | |
136-
| | - swing_sd | |
137-
| | - swing_median | |
138-
| | - swing_amplitude | |
139-
+-------------------------+-------------------------------------------------------+---------------------------------------+
140-
| SpatialFeatures | - step_length [2] | |
141-
| | - stride_length [2] | |
142-
| | - step_width [2] | |
143-
| | - minimal_toe_clearance [3] | |
144-
+-------------------------+-------------------------------------------------------+---------------------------------------+
145-
| TemporalFeatures | - cycle_duration | |
146-
| | - swing_duration_perc | |
147-
| | - stance_duration_perc | |
148-
| | - cadence [2] | |
149-
| | - single_support_duration_percent [4] | |
150-
| | - double_support_duration_percent [4] | |
151-
+-------------------------+-------------------------------------------------------+---------------------------------------+
152-
153-
References
154-
""""""""""
155-
[1] J. A. Zeni, J. G. Richards, and J. S. Higginson,
156-
“Two simple methods for determining gait events during treadmill and overground walking
157-
using kinematic data,” Gait and Posture, vol. 27, pp. 710–714, May 2008,
158-
doi: 10.1016/j.gaitpost.2007.07.007.
159-
160-
[2] J. H. Hollman, E. M. McDade, and R. C. Petersen, “Normative Spatiotemporal
161-
Gait Parameters in Older Adults,” Gait Posture, vol. 34, no. 1, pp. 111–118,
162-
May 2011, doi: 10.1016/j.gaitpost.2011.03.024.
163-
164-
[3] B. W. Schulz, “A new measure of trip risk integrating minimum foot clearance and
165-
dynamic stability across the swing phase of gait,” Journal of Biomechanics,
166-
vol. 55, pp. 107–112, Apr. 2017, doi: 10.1016/j.jbiomech.2017.02.024.
167-
168-
[4] A. Gouelle and F. Mégrot, “Interpreting Spatiotemporal Parameters, Symmetry,
169-
and Variability in Clinical Gait Analysis,” Handbook of Human Motion,
170-
pp. 1–20, 2016, doi: 10.1007/978-3-319-30808-1_35-1.
171-
118+
+-------------------------+-----------------------------------------------------------------+---------------------------------------+
119+
| Method | Description | options |
120+
+=========================+=================================================================+=======================================+
121+
| TimeSeriesFeatures | - min | |
122+
| | - max | |
123+
| | - mean | |
124+
| | - sd | |
125+
| | - median | |
126+
| | - amplitude | |
127+
+-------------------------+-----------------------------------------------------------------+---------------------------------------+
128+
| PhaseTimeSeriesFeatures | - stand_min | |
129+
| | - stand_max | |
130+
| | - stand_mean | |
131+
| | - stand_sd | |
132+
| | - stand_median | |
133+
| | - stand_amplitude | |
134+
| | - swing_max | |
135+
| | - swing_mean | |
136+
| | - swing_sd | |
137+
| | - swing_median | |
138+
| | - swing_amplitude | |
139+
+-------------------------+-----------------------------------------------------------------+---------------------------------------+
140+
| SpatialFeatures | - step_length [2]_ | |
141+
| | - stride_length [2]_ | |
142+
| | - step_width [2]_ | |
143+
| | - minimal_toe_clearance [3]_ | |
144+
+-------------------------+-----------------------------------------------------------------+---------------------------------------+
145+
| TemporalFeatures | - cycle_duration | |
146+
| | - swing_duration_perc | |
147+
| | - stance_duration_perc | |
148+
| | - cadence [2]_ | |
149+
| | - single_support_duration_percent [4]_ | |
150+
| | - double_support_duration_percent [4]_ | |
151+
+-------------------------+-----------------------------------------------------------------+---------------------------------------+
172152

173153
Quickstart
174154
----------
@@ -200,7 +180,7 @@ are configured in as specific yaml file.
200180

201181
Minimal requirements would look like this:
202182

203-
.. code:: yaml
183+
.. code-block:: yaml
204184
205185
# Markers to analyse
206186
analysis:
@@ -231,11 +211,9 @@ Minimal requirements would look like this:
231211

232212
Simple Pipeline
233213
^^^^^^^^^^^^^^^^
234-
235-
.. code:: python
214+
.. code-block:: python
236215
237216
from gaitalytics import api
238-
239217
# Load configuration (yaml file from above)
240218
config = api.load_config("./pig_config.yaml")
241219
@@ -272,12 +250,24 @@ Simple Pipeline
272250
273251
except ValueError as e:
274252
print(e)
253+
..
275254
276255
Documentation
277256
-------------
278-
279257
https://python-gaitalytics.readthedocs.org
280258

259+
.. rubric:: References
260+
261+
.. [1] Zeni Joseph, F. Pozzi, S. Abujaber, and L. Miller, “Relationship between physical impairments and movement patterns during gait in patients with end‐stage hip osteoarthritis,” J Orthopaed Res, vol. 33, no. 3, pp. 382–389, 2015, doi: 10.1002/jor.22772.
262+
263+
.. [2] J. H. Hollman, E. M. McDade, and R. C. Petersen, “Normative Spatiotemporal Gait Parameters in Older Adults,” Gait Posture, vol. 34, no. 1, pp. 111–118, May 2011, doi: 10.1016/j.gaitpost.2011.03.024.`
264+
265+
.. [3] B. W. Schulz, “A new measure of trip risk integrating minimum foot clearance and dynamic stability across the swing phase of gait,” Journal of Biomechanics, vol. 55, pp. 107–112, Apr. 2017, doi: 10.1016/j.jbiomech.2017.02.024.
266+
267+
.. [4] A. Gouelle and F. Mégrot, “Interpreting Spatiotemporal Parameters, Symmetry, and Variability in Clinical Gait Analysis,” Handbook of Human Motion, pp. 1–20, 2016, doi: 10.1007/978-3-319-30808-1_35-1.
268+
269+
270+
281271
282272
283273

0 commit comments

Comments
 (0)