BREAKING CHANGE: InjectionDynamics

docs/source/example_workflow/example_workflow.py

@@ -5,9 +5,18 @@
 from aind_data_schema_models.organizations import Organization
 
 from aind_data_schema.core.data_description import Funding, RawDataDescription
-from aind_data_schema.core.procedures import NanojectInjection, Perfusion, Procedures, Surgery, ViralMaterial
+from aind_data_schema.core.procedures import (
+    NanojectInjection,
+    Perfusion,
+    Procedures,
+    Surgery,
+    ViralMaterial,
+    InjectionDynamics,
+    InjectionProfile,
+)
 from aind_data_schema.core.subject import BreedingInfo, Housing, Species, Subject
 from aind_data_schema_models.species import Strain
+from aind_data_schema_models.units import VolumeUnit
 
 from aind_data_schema.components.identifiers import Person
 
@@ -105,7 +114,13 @@
                         injection_angle=float(coords[3]),
                         # multiple injection volumes at different depths are allowed, but that's not happening here
                         injection_coordinate_depth=[float(coords[2])],
-                        injection_volume=[float(proc_row["injection_volume"])],
+                        dynamics=[
+                            InjectionDynamics(
+                                volume=proc_row["injection_volume"],
+                                volume_unit=VolumeUnit.NL,
+                            )
+                        ],
+                        profile=InjectionProfile.BOLUS,
                     )
                 ],
             ),

examples/ophys_procedures.py

@@ -21,7 +21,10 @@
     Surgery,
     ViralMaterial,
     WaterRestriction,
+    InjectionDynamics,
+    InjectionProfile,
 )
+from aind_data_schema_models.units import VolumeUnit
 from aind_data_schema_models.brain_atlas import CCFStructure
 
 t = datetime.datetime(2022, 7, 12, 7, 00, 00)
@@ -68,7 +71,13 @@
                     injection_coordinate_depth=[-4.2],
                     injection_coordinate_reference="Bregma",
                     injection_angle=0,
-                    injection_volume=[400],
+                    dynamics=[
+                        InjectionDynamics(
+                            volume=400,
+                            volume_unit=VolumeUnit.NL,
+                        )
+                    ],
+                    profile=InjectionProfile.BOLUS,
                     targeted_structure=CCFStructure.VTA,
                 ),
                 FiberImplant(

examples/procedures.py

@@ -12,8 +12,11 @@
     Surgery,
     TarsVirusIdentifiers,
     ViralMaterial,
+    InjectionDynamics,
+    InjectionProfile,
 )
 from aind_data_schema_models.brain_atlas import CCFStructure
+from aind_data_schema_models.units import VolumeUnit
 
 # If a timezone isn't specified, the timezone of the computer running this
 # script will be used as default
@@ -62,7 +65,8 @@
                     injection_coordinate_reference="Lambda",
                     bregma_to_lambda_distance=4.1,
                     injection_angle=10,
-                    injection_volume=[200],
+                    dynamics=[InjectionDynamics(volume=200, volume_unit=VolumeUnit.NL)],
+                    profile=InjectionProfile.BOLUS,
                     targeted_structure=CCFStructure.VISP,
                 ),
             ],

src/aind_data_schema/core/procedures.py

@@ -168,6 +168,14 @@ class SampleType(str, Enum):
     OTHER = "Other"
 
 
+class InjectionProfile(str, Enum):
+    """Injection profile"""
+
+    BOLUS = "Bolus"
+    CONTINUOUS = "Continuous"
+    PULSED = "Pulsed"
+
+
 class Readout(Reagent):
     """Description of a readout"""
 
@@ -426,6 +434,17 @@ class NonViralMaterial(Reagent):
     )
 
 
+class InjectionDynamics(DataModel):
+    """Description of the volume and rate of an injection"""
+
+    volume: Decimal = Field(..., title="Injection volume")
+    volume_unit: VolumeUnit = Field(..., title="Injection volume unit")
+    rate: Optional[Decimal] = Field(default=None, title="Injection rate")
+    rate_unit: Optional[VolumeUnit] = Field(default=None, title="Injection rate unit")
+    duration: Optional[Decimal] = Field(default=None, title="Injection duration")
+    duration_unit: Optional[TimeUnit] = Field(default=None, title="Injection duration unit")
+
+
 class Injection(DataModel):
     """Description of an injection procedure"""
 
@@ -434,27 +453,31 @@ class Injection(DataModel):
     ] = Field(..., title="Injection material", min_length=1)
     recovery_time: Optional[Decimal] = Field(default=None, title="Recovery time")
     recovery_time_unit: Optional[TimeUnit] = Field(default=None, title="Recovery time unit")
-    injection_duration: Optional[Decimal] = Field(default=None, title="Injection duration")
-    injection_duration_unit: Optional[TimeUnit] = Field(default=None, title="Injection duration unit")
+    dynamics: List[InjectionDynamics] = Field(
+        ..., title="Injection dynamics", description="List of injection events, pattern should match the profile"
+    )
+    profile: InjectionProfile = Field(..., title="Injection profile")
     instrument_id: Optional[str] = Field(default=None, title="Instrument ID")
     protocol_id: str = Field(..., title="Protocol ID", description="DOI for protocols.io")
 
+    @model_validator(mode="after")
+    def profile_validator(values):
+        """Check that the profile is allowed given the dynamics"""
+
+        if len(values.dynamics) > 1 and values.profile == InjectionProfile.BOLUS:
+            raise AssertionError("Bolus profile is not allowed for multiple injection events")
+        return values
+
 
 class RetroOrbitalInjection(Injection):
     """Description of a retro-orbital injection procedure"""
 
-    injection_volume: Decimal = Field(..., title="Injection volume (uL)")
-    injection_volume_unit: VolumeUnit = Field(default=VolumeUnit.UL, title="Injection volume unit")
     injection_eye: Side = Field(..., title="Injection eye")
 
 
 class IntraperitonealInjection(Injection):
     """Description of an intraperitoneal injection procedure"""
 
-    time: Optional[AwareDatetimeWithDefault] = Field(default=None, title="Injection time")
-    injection_volume: Decimal = Field(..., title="Injection volume (uL)")
-    injection_volume_unit: VolumeUnit = Field(default=VolumeUnit.UL, title="Injection volume unit")
-
 
 class BrainInjection(Injection):
     """Description of a brain injection procedure"""
@@ -479,23 +502,16 @@ class BrainInjection(Injection):
 class NanojectInjection(BrainInjection):
     """Description of a nanoject injection procedure"""
 
-    injection_volume: List[Decimal] = Field(
-        ...,
-        title="Injection volume (nL)",
-        description="Injection volume, one value per location",
-    )
-    injection_volume_unit: VolumeUnit = Field(VolumeUnit.NL, title="Injection volume unit")
-
-    @field_validator("injection_volume")
-    def check_dv_and_vol_list_lengths(cls, v, info: ValidationInfo):
+    @model_validator(mode="after")
+    def check_dv_and_vol_list_lengths(values):
         """Validator for list length of injection volumes and depths"""
 
-        injection_vol_len = len(v)
-        coords_len = len(info.data["injection_coordinate_depth"])
+        dynamics_len = len(values.dynamics)
+        coords_len = len(values.injection_coordinate_depth)
 
-        if injection_vol_len != coords_len:
+        if dynamics_len != coords_len:
             raise AssertionError("Unmatched list sizes for injection volumes and coordinate depths")
-        return v
+        return values
 
 
 class IontophoresisInjection(BrainInjection):
@@ -509,24 +525,10 @@ class IontophoresisInjection(BrainInjection):
 class IntraCerebellarVentricleInjection(BrainInjection):
     """Description of an interacerebellar ventricle injection"""
 
-    injection_volume: List[Decimal] = Field(
-        ...,
-        title="Injection volume (nL)",
-        description="Injection volume, one value per location",
-    )
-    injection_volume_unit: VolumeUnit = Field(VolumeUnit.NL, title="Injection volume unit")
-
 
 class IntraCisternalMagnaInjection(BrainInjection):
     """Description of an interacisternal magna injection"""
 
-    injection_volume: List[Decimal] = Field(
-        ...,
-        title="Injection volume (nL)",
-        description="Injection volume, one value per location",
-    )
-    injection_volume_unit: VolumeUnit = Field(VolumeUnit.NL, title="Injection volume unit")
-
 
 class SampleCollection(DataModel):
     """Description of a single sample collection"""