Merge pull request #207 from NeurodataWithoutBorders/check_angle

check CompassDirection angle

Author: CodyCBakerPhD

nwbinspector/checks/behavior.py

@@ -1,5 +1,5 @@
 """Checks for types belonging to the pynwb.behavior module."""
-from pynwb.behavior import SpatialSeries
+from pynwb.behavior import SpatialSeries, CompassDirection
 
 from ..register_checks import register_check, Importance, InspectorMessage
 
@@ -11,3 +11,13 @@ def check_spatial_series_dims(spatial_series: SpatialSeries):
         return InspectorMessage(
             message="SpatialSeries should have 1 column (x), 2 columns (x, y), or 3 columns (x, y, z)."
         )
+
+
+@register_check(importance=Importance.BEST_PRACTICE_VIOLATION, neurodata_type=SpatialSeries)
+def check_compass_direction_unit(compass_direction: CompassDirection):
+    for spatial_series in compass_direction.spatial_series.values():
+        if spatial_series.unit not in ("degrees", "radians"):
+            yield InspectorMessage(
+                message=f"SpatialSeries objects inside a CompassDirection object should be angular and should have a "
+                f"unit of 'degrees' or 'radians', but '{spatial_series.name}' has units '{spatial_series.unit}'."
+            )

tests/unit_tests/test_behavior.py

@@ -1,7 +1,8 @@
-from pynwb.behavior import SpatialSeries
+from pynwb.behavior import SpatialSeries, CompassDirection
 import numpy as np
 
-from nwbinspector import InspectorMessage, Importance, check_spatial_series_dims
+from nwbinspector import InspectorMessage, Importance
+from nwbinspector.checks.behavior import check_compass_direction_unit, check_spatial_series_dims
 
 
 def test_check_spatial_series_dims():
@@ -47,3 +48,36 @@ def test_pass_check_spatial_series_dims_1d():
     )
 
     assert check_spatial_series_dims(spatial_series) is None
+
+
+def test_trigger_check_compass_direction_unit():
+    obj = CompassDirection(
+        spatial_series=SpatialSeries(
+            name="SpatialSeries",
+            description="description",
+            data=np.ones((10,)),
+            rate=3.0,
+            reference_frame="reference_frame",
+        )
+    )
+
+    assert (
+        check_compass_direction_unit(obj)[0].message == f"SpatialSeries objects inside a CompassDirection object "
+        f"should be angular and should have a unit of 'degrees' or 'radians', but 'SpatialSeries' has units 'meters'."
+    )
+
+
+def test_pass_check_compass_direction_unit():
+    for unit in ("radians", "degrees"):
+        obj = CompassDirection(
+            spatial_series=SpatialSeries(
+                name="SpatialSeries",
+                description="description",
+                data=np.ones((10,)),
+                rate=3.0,
+                reference_frame="reference_frame",
+                unit=unit,
+            )
+        )
+
+        assert check_compass_direction_unit(obj) is None