Skip to content

Commit 1dfaac1

Browse files
author
André Böni
committed
+ Library overview
1 parent 4d7baeb commit 1dfaac1

File tree

1 file changed

+1
-126
lines changed

1 file changed

+1
-126
lines changed

‎README.rst

Lines changed: 1 addition & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -42,114 +42,6 @@ it is necessary to perform data labeling, modeling, and filtering procedures.
4242
The library's versatility allows it to be adaptable to various marker sets and modeling algorithms,
4343
offering high configurability.
4444

45-
46-
Functionalities
47-
---------------
48-
49-
Input
50-
^^^^^
51-
Currently only c3d files are supported.
52-
The library provides a function to load a c3d file into a trial object for usage in the library.
53-
54-
.. note::
55-
future efforts will be made to support other file formats such as trc, mot, sto and mox files.
56-
57-
Event Detection
58-
^^^^^^^^^^^^^^^
59-
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-
+------------+---------------------------------+----------------------------------------------------------------------------+
68-
69-
70-
Event Detection Check
71-
^^^^^^^^^^^^^^^^^^^^^
72-
73-
+------------+--------------------------------------------------+-------------------------+
74-
| Method | Description | options |
75-
+============+==================================================+=========================+
76-
| sequence | Checks gait event sequences | |
77-
| | - Heel Strike - Toe off - Heel Strike - Toe off | |
78-
| | - Left - Right - Left - Right | |
79-
+------------+--------------------------------------------------+-------------------------+
80-
81-
Event Writing
82-
^^^^^^^^^^^^^
83-
84-
Currently only c3d files are supported.
85-
The main usage for this feature is the correction of detected events.
86-
87-
Segmentation
88-
^^^^^^^^^^^^
89-
90-
Currently only the segmentation based on gait-events is supported.
91-
92-
+------------+--------------------------------------------------+-------------------------+
93-
| Method | Description | options |
94-
+============+==================================================+=========================+
95-
| HS | Segment based on heel strike | |
96-
+------------+--------------------------------------------------+-------------------------+
97-
| TO | Segment based on toe off | |
98-
+------------+--------------------------------------------------+-------------------------+
99-
100-
Time Normalization
101-
^^^^^^^^^^^^^^^^^^
102-
Currently only linear time normalization is supported.
103-
104-
.. note::
105-
future efforts will be made to support other time normalization
106-
methods such as dynamic time warping.
107-
108-
+------------+--------------------------------------------------+-------------------------+
109-
| Method | Description | options |
110-
+============+==================================================+=========================+
111-
| linear | Linear time-normalisation | |
112-
+------------+--------------------------------------------------+-------------------------+
113-
114-
115-
Feature calculation
116-
^^^^^^^^^^^^^^^^^^^
117-
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-
15345
Quickstart
15446
----------
15547

@@ -182,10 +74,8 @@ Minimal requirements would look like this:
18274

18375
.. code-block:: yaml
18476
185-
# Markers to analyse
18677
analysis:
187-
markers: # Markers to analyse
188-
# Left side
78+
markers:
18979
- "LHipAngles"
19080
- "LKneeAngles"
19181
- "LAnkleAngles"
@@ -256,18 +146,3 @@ Documentation
256146
-------------
257147
https://python-gaitalytics.readthedocs.org
258148

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-
271-
272-
273-

0 commit comments

Comments
 (0)