feat: adds optional anatomical coordinates and reference fields to Ma…

…nipulator Module
AllenNeuralDynamics · Aug 6, 2024 · 4df37a0 · 4df37a0
1 parent 5aeea41
commit 4df37a0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/examples/ephys_session.json b/examples/ephys_session.json
@@ -54,6 +54,8 @@
                   "z": "11087.5",
                   "unit": "micrometer"
                },
+               "anatomical_coordinates": null,
+               "anatomical_reference": null,
                "bregma_coordinates": null,
                "surface_z": null,
                "surface_z_unit": "micrometer",
@@ -86,6 +88,8 @@
                   "z": "13262",
                   "unit": "micrometer"
                },
+               "anatomical_coordinates": null,
+               "anatomical_reference": null,
                "bregma_coordinates": null,
                "surface_z": null,
                "surface_z_unit": "micrometer",
@@ -187,6 +191,8 @@
                   "z": "11087.5",
                   "unit": "micrometer"
                },
+               "anatomical_coordinates": null,
+               "anatomical_reference": null,
                "bregma_coordinates": null,
                "surface_z": null,
                "surface_z_unit": "micrometer",
@@ -219,6 +225,8 @@
                   "z": "13262",
                   "unit": "micrometer"
                },
+               "anatomical_coordinates": null,
+               "anatomical_reference": null,
                "bregma_coordinates": null,
                "surface_z": null,
                "surface_z_unit": "micrometer",

diff --git a/src/aind_data_schema/core/session.py b/src/aind_data_schema/core/session.py
@@ -39,7 +39,7 @@
     VisualStimulation,
 )
 from aind_data_schema.components.tile import Channel
-from aind_data_schema.core.procedures import Anaesthetic
+from aind_data_schema.core.procedures import Anaesthetic, CoordinateReferenceLocation
 
 
 class StimulusModality(str, Enum):
@@ -217,6 +217,10 @@ class ManipulatorModule(DomeModule):
         ...,
         title="Manipulator coordinates",
     )
+    anatomical_coordinates: Optional[Coordinates3d] = Field(default=None, title="Anatomical coordinates")
+    anatomical_reference: Optional[
+        Literal[CoordinateReferenceLocation.BREGMA, CoordinateReferenceLocation.LAMBDA]
+    ] = Field(default=None, title="Anatomical coordinate reference")
     bregma_coordinates: Optional[Coordinates3d] = Field(default=None, title="Bregma coordinates")
     surface_z: Optional[Decimal] = Field(default=None, title="Surface z")
     surface_z_unit: SizeUnit = Field(SizeUnit.UM, title="Surface z unit")