+ fix bug no event section

Author: André Böni

CHANGELOG.rst

@@ -2,6 +2,10 @@
 Changelog
 =========
 
+0.2.1
+------------------
+- Fixed bug for get events when no events entry is present in c3d file
+
 0.2.0
 ------------------
 Breaking changes:

gaitalytics/io.py

@@ -139,14 +139,14 @@ def __init__(self, file_path: Path):
         self._c3d = ezc3d.c3d(str(file_path))
         super().__init__(file_path)
 
-    def get_events(self) -> pd.DataFrame:
+    def get_events(self) -> pd.DataFrame | None:
         """Gets the events from the input file sorted by time.
 
         Returns:
-            A DataFrame containing the events.
+            pd.DataFrame A DataFrame containing the events.
+            None if there are no events in the C3D file.
+
 
-        Raises:
-            ValueError: If no events are found in the C3D file.
         """
         labels = self._get_event_labels()
         times = self._get_event_times()
@@ -155,7 +155,7 @@ def get_events(self) -> pd.DataFrame:
 
         # Check if there are any events in the C3D file
         if not (labels and times and contexts and icons):
-            raise ValueError("No events found in the C3D file.")
+            return None
 
         table = pd.DataFrame(
             {

tests/full/data/treadmill_no_events.c3d

@@ -39,17 +39,23 @@ def test_load_config():
 
 def test_load_c3d_trial():
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     assert len(trial.get_all_data().keys()) == 3
     assert trial.events is not None
 
 
+def test_load_c3d_trial_no_events():
+    config = api.load_config("./tests/pig_config.yaml")
+    trial = api.load_c3d_trial("./tests/treadmill_no_events.c3d", config)
+    assert trial.events is None
+
+
 def test_detect_events():
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     event_table = api.detect_events(trial, config, distance=1000)
     assert event_table is not None
-    assert len(event_table) == 4
+    assert len(event_table) == 5
 
 
 def test_detect_events_methode():
@@ -61,7 +67,7 @@ def test_detect_events_methode():
 
 def test_check_events():
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     api.check_events(trial.events)
     assert True
 
@@ -73,15 +79,15 @@ def test_check_events_methode():
 
 def test_write_events(out_path):
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     event_table = api.detect_events(trial, config, distance=1000)
-    api.write_events_to_c3d("./tests/test_small.c3d", event_table, out_path)
+    api.write_events_to_c3d("./tests/treadmill_no_events.c3d", event_table, out_path)
     assert True
 
 
 def test_segment_trial():
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     segm_trial = api.segment_trial(trial)
     assert len(segm_trial.get_all_cycles().keys()) == 2
 
@@ -100,22 +106,22 @@ def test_segment_trial_method():
 
 def test_time_normalize_trail():
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     norm_trial = api.time_normalise_trial(trial)
     assert norm_trial is not None
 
 
 def test_time_normalize_cycle_trial():
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     trial_cycles = api.segment_trial(trial)
     norm_trial = api.time_normalise_trial(trial_cycles)
     assert norm_trial is not None
 
 
 def test_time_normalize_trial_frames():
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     trial_cycles = api.segment_trial(trial)
     norm_trial = api.time_normalise_trial(trial_cycles, n_frames=200)
     markers = norm_trial.get_cycle("Left", 0).get_data(model.DataCategory.MARKERS)
@@ -124,15 +130,15 @@ def test_time_normalize_trial_frames():
 
 def test_calculate_features():
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     trial_cycles = api.segment_trial(trial)
     features = api.calculate_features(trial_cycles, config)
-    assert features.shape == (2, 2, 2278)
+    assert features.shape == (2, 10, 2278)
 
 
 def test_export_trial(out_folder):
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     api.export_trial(trial, out_folder)
     assert (out_folder / "markers.nc").exists()
     assert (out_folder / "analogs.nc").exists()
@@ -141,7 +147,7 @@ def test_export_trial(out_folder):
 
 def test_export_segmented_trial(out_folder):
     config = api.load_config("./tests/pig_config.yaml")
-    trial = api.load_c3d_trial("./tests/test_small.c3d", config)
+    trial = api.load_c3d_trial("./tests/treadmill_events.c3d", config)
     trial_cycles = api.segment_trial(trial)
     api.export_trial(trial_cycles, out_folder)
     assert (out_folder / "markers.nc").exists()