Skip to content

Commit 3a21b36

Browse files
reordering of example
1 parent 7026ba2 commit 3a21b36

21 files changed

+29
-27
lines changed

docs/examples/basic_00_load_Data_into_KielMAT.md renamed to docs/examples/basic_01_load_Data_into_KielMAT.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Tutorial: Load data into an `KielMATRecording` object
22

33
**Author:** Julius Welzel
4+
45
**Last update:** Fri 22 Mar 2024
56

67
## Learning objectives
78
By the end of this tutorial:
9+
810
- you can load data and channel information into an `KielMATRecording` object
911
- you can add Recording specific information to the `KielMATRecording` object
1012
- you are educated about the relationship between a `KielMATRecording` object and the [BIDS standard](https://bids-specification.readthedocs.io/en/stable/).
@@ -141,7 +143,7 @@ print(recording.events)
141143

142144

143145

144-
![png](basic_00_load_Data_into_KielMAT_files/basic_00_load_Data_into_KielMAT_1.png)
146+
![png](basic_01_load_Data_into_KielMAT_files/basic_01_load_Data_into_KielMAT_1.png)
145147

146148

147149

File renamed without changes.
File renamed without changes.

docs/examples/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,30 @@ This section contains a series of examples designed to demonstrate key features
66

77
The `DataClass` is the central data structure in KielMAT, which stores and organizes motion data along with associated events. The following examples guide you through the process of loading and structuring your data.
88

9-
### [Example 1: Load data into KielMAT](basic_00_load_Data_into_KielMAT.md)
9+
### [Example 1: Load data into KielMAT](basic_01_load_Data_into_KielMAT.md)
1010
In this example, you will learn how to load motion data into `KielMAT`'s `DataClass`. This step is essential for processing any motion capture data, whether it's from IMUs, C3D files, or other data formats.
1111

12-
### [Example 2: Load datasets](basic_01_load_dataset.md)
12+
### [Example 2: Load datasets](basic_02_load_dataset.md)
1313
This example demonstrates how to load datasets into `KielMAT`. You will learn how to import data from different sources, handle multiple datasets, and integrate them into a unified structure for analysis.
1414

15-
### [Example 3: Events in DataClass](basic_02_events.md)
15+
### [Example 3: Events in DataClass](basic_03_events.md)
1616
The `DataClass` not only stores motion data but also provides functionality to mark and organize events (such as gait sequences, initial contacts, or other notable movement occurrences). This example shows how to tag specific events within the `DataClass`, allowing you to analyze them in the context of the motion data.
1717

1818
## Run Modules
1919

2020
KielMAT includes several pre-built modules to analyze motion data for different tasks. The following examples demonstrate how to apply each module to extract meaningful information from your data.
2121

22-
### [Example 1: Gait Sequence Detection](modules_01_gsd.md)
22+
### [Example 4: Gait Sequence Detection](modules_04_gsd.md)
2323
This example introduces the [Gait Sequence Detection](https://neurogeriatricskiel.github.io/KielMAT/modules/gsd/) module. This module identifies gait sequences using 3D accelerometer data from a lower back sensor.
2424

25-
### [Example 2: Initial Contact Detection](modules_02_icd.md)
25+
### [Example 5: Initial Contact Detection](modules_05_icd.md)
2626
This example introduces the [Initial Contact Detection](https://neurogeriatricskiel.github.io/KielMAT/modules/icd/) module. It identifies and characterizes initial contacts within each detected gait sequence using the gait sequence detection module.
2727

28-
### [Example 3: Physical Activity Monitoring](modules_03_pam.md)
28+
### [Example 6: Physical Activity Monitoring](modules_06_pam.md)
2929
This example introduces the [Physical Activity Monitoring](https://neurogeriatricskiel.github.io/KielMAT/modules/pam/) module. The example shows how the module is implemented on sample 3D acceleration data from an IMU sensor to monitor physical activity levels.
3030

31-
### [Example 4: Postural Transition Detection](modules_04_ptd.md)
31+
### [Example 7: Postural Transition Detection](modules_07_ptd.md)
3232
This example introduces the [Postural Transition Detection](https://neurogeriatricskiel.github.io/KielMAT/modules/ptd/) module. It demonstrates how the module is implemented on sample 3D acceleration and 3D angular velocity data from a lower back IMU sensor to detect postural transitions, such as sit-to-stand or stand-to-sit.
3333

34-
### [Example 5: Turn Detection](modules_05_td.md)
34+
### [Example 8: Turn Detection](modules_08_td.md)
3535
This example introduces the [Turn Detection](https://neurogeriatricskiel.github.io/KielMAT/modules/td/) module. It demonstrates how the module is implemented on sample 3D acceleration and 3D angular velocity data from a lower back IMU sensor to detect turns.

docs/examples/modules_01_gsd.md renamed to docs/examples/modules_04_gsd.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ plt.show()
159159

160160

161161

162-
![](modules_01_gsd_files/modules_01_gsd_7_0.png)
162+
![](modules_04_gsd_files/modules_04_gsd_7_0.png)
163163

164164

165165

@@ -210,7 +210,7 @@ plt.show()
210210

211211

212212

213-
![](modules_01_gsd_files/modules_01_gsd_9_0.png)
213+
![](modules_04_gsd_files/modules_04_gsd_9_0.png)
214214

215215

216216

@@ -250,7 +250,7 @@ print(recording.events)
250250

251251

252252

253-
![](modules_01_gsd_files/modules_01_gsd_11_1.png)
253+
![](modules_04_gsd_files/modules_04_gsd_11_1.png)
254254

255255

256256

@@ -352,6 +352,6 @@ plt.show()
352352

353353

354354

355-
![](modules_01_gsd_files/modules_01_gsd_13_1.png)
355+
![](modules_04_gsd_files/modules_04_gsd_13_1.png)
356356

357357

0 commit comments

Comments
 (0)