+ open events api for external methods

Author: André Böni

gaitalytics/api.py

@@ -93,14 +93,17 @@ def load_c3d_trial(
 
 
 def detect_events(
-    trial: model.Trial, config: mapping.MappingConfigs, method: str = "Marker", **kwargs
+    trial: model.Trial,
+    config: mapping.MappingConfigs,
+    method: type[events.BaseEventDetection] = events.MarkerEventDetection,
+    **kwargs,
 ) -> pd.DataFrame:
     """Detects the events in the trial.
 
     Args:
         trial: The trial to detect the events for.
         config: The mapping configurations
-        method: The method to use for detecting the events.
+        method: The class to use for detecting the events.
                 Currently, only "Marker" is supported, which implements
                 the method from Zenis et al. 2008.
                 Default is "Marker".
@@ -113,15 +116,9 @@ def detect_events(
     Returns:
         A DataFrame containing the detected events.
 
-    Raises:
-        ValueError: If the method is not supported.
     """
 
-    match method:
-        case "Marker":
-            method_obj = events.MarkerEventDetection(config, **kwargs)
-        case _:
-            raise ValueError(f"Unsupported method: {method}")
+    method_obj = method(config, **kwargs)
 
     event_table = method_obj.detect_events(trial)
     return event_table

gaitalytics/events.py

@@ -143,7 +143,7 @@ def _check_contexts(self, events: pd.DataFrame) -> list[tuple]:
         return incorrect_times
 
 
-class _BaseEventDetection(ABC):
+class BaseEventDetection(ABC):
     """Abstract class for event detectors.
 
     This class provides a common interface for detecting events in a trial,
@@ -171,7 +171,7 @@ def detect_events(self, trial: model.Trial) -> pd.DataFrame:
         raise NotImplementedError
 
 
-class MarkerEventDetection(_BaseEventDetection):
+class MarkerEventDetection(BaseEventDetection):
     """A class for detecting events using marker data.
 
     This class provides a method to detect events using marker data in a trial.

tests/test_api.py

@@ -4,6 +4,7 @@
 import pandas as pd
 import pytest
 
+import gaitalytics.events as events
 import gaitalytics.api as api
 import gaitalytics.mapping as mapping
 import gaitalytics.model as model
@@ -61,8 +62,8 @@ def test_detect_events():
 def test_detect_events_methode():
     config = api.load_config("./tests/pig_config.yaml")
     trial = model.Trial()
-    with pytest.raises(ValueError):
-        api.detect_events(trial, config, method="ForcePlate")
+    with pytest.raises(TypeError):
+        api.detect_events(trial, config, method= events.BaseEventDetection)
 
 
 def test_check_events():