feat(devices): add crop offset x and y to camera (#1015)

* feat(devices): add crop offset x and y to camera * add crop offset to example files to make tests pass
AllenNeuralDynamics · Aug 13, 2024 · 14888c4 · 14888c4
1 parent 7565ff6
commit 14888c4
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 5 deletions.
diff --git a/examples/aibs_smartspim_instrument.json b/examples/aibs_smartspim_instrument.json
@@ -98,6 +98,8 @@
          "bin_height": null,
          "bin_unit": "pixel",
          "gain": null,
+         "crop_offset_x": null,
+         "crop_offset_y": null,
          "crop_width": null,
          "crop_height": null,
          "crop_unit": "pixel",
@@ -506,4 +508,4 @@
    ],
    "daqs": [],
    "notes": null
-}
+}
diff --git a/examples/aind_smartspim_instrument.json b/examples/aind_smartspim_instrument.json
@@ -118,6 +118,8 @@
          "bin_height": null,
          "bin_unit": "pixel",
          "gain": null,
+         "crop_offset_x": null,
+         "crop_offset_y": null,
          "crop_width": null,
          "crop_height": null,
          "crop_unit": "pixel",
@@ -633,4 +635,4 @@
    ],
    "daqs": [],
    "notes": null
-}
+}
diff --git a/examples/ephys_rig.json b/examples/ephys_rig.json
@@ -64,6 +64,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -171,6 +173,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -354,6 +358,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -430,6 +436,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -506,6 +514,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -582,6 +592,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",

diff --git a/examples/exaspim_instrument.json b/examples/exaspim_instrument.json
@@ -95,6 +95,8 @@
          "bin_height": null,
          "bin_unit": "pixel",
          "gain": null,
+         "crop_offset_x": null,
+         "crop_offset_y": null,
          "crop_width": null,
          "crop_height": null,
          "crop_unit": "pixel",
@@ -455,4 +457,4 @@
       }
    ],
    "notes": null
-}
+}
diff --git a/examples/fip_behavior_rig.json b/examples/fip_behavior_rig.json
@@ -138,6 +138,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -213,6 +215,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -390,6 +394,8 @@
          "bin_height": 4,
          "bin_unit": "pixel",
          "gain": "2",
+         "crop_offset_x": 0,
+         "crop_offset_y": 0,
          "crop_width": 200,
          "crop_height": 200,
          "crop_unit": "pixel",
@@ -434,6 +440,8 @@
          "bin_height": 4,
          "bin_unit": "pixel",
          "gain": "2",
+         "crop_offset_x": 0,
+         "crop_offset_y": 0,
          "crop_width": 200,
          "crop_height": 200,
          "crop_unit": "pixel",
@@ -937,4 +945,4 @@
       }
    ],
    "notes": null
-}
+}
diff --git a/examples/fip_behavior_rig.py b/examples/fip_behavior_rig.py
@@ -167,6 +167,8 @@
             bin_width=4,
             bin_height=4,
             bin_mode="Additive",
+            crop_offset_x=0,
+            crop_offset_y=0,
             crop_width=200,
             crop_height=200,
             gain=2,
@@ -185,6 +187,8 @@
             bin_width=4,
             bin_height=4,
             bin_mode="Additive",
+            crop_offset_x=0,
+            crop_offset_y=0,
             crop_width=200,
             crop_height=200,
             gain=2,

diff --git a/examples/fip_ophys_rig.json b/examples/fip_ophys_rig.json
@@ -124,6 +124,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -199,6 +201,8 @@
             "bin_height": null,
             "bin_unit": "pixel",
             "gain": null,
+            "crop_offset_x": null,
+            "crop_offset_y": null,
             "crop_width": null,
             "crop_height": null,
             "crop_unit": "pixel",
@@ -376,6 +380,8 @@
          "bin_height": 4,
          "bin_unit": "pixel",
          "gain": "2",
+         "crop_offset_x": 0,
+         "crop_offset_y": 0,
          "crop_width": 200,
          "crop_height": 200,
          "crop_unit": "pixel",
@@ -420,6 +426,8 @@
          "bin_height": 4,
          "bin_unit": "pixel",
          "gain": "2",
+         "crop_offset_x": 0,
+         "crop_offset_y": 0,
          "crop_width": 200,
          "crop_height": 200,
          "crop_unit": "pixel",
@@ -891,4 +899,4 @@
       }
    ],
    "notes": null
-}
+}
diff --git a/examples/fip_ophys_rig.py b/examples/fip_ophys_rig.py
@@ -113,6 +113,8 @@
             bin_width=4,
             bin_height=4,
             bin_mode="Additive",
+            crop_offset_x=0,
+            crop_offset_y=0,
             crop_width=200,
             crop_height=200,
             gain=2,
@@ -131,6 +133,8 @@
             bin_width=4,
             bin_height=4,
             bin_mode="Additive",
+            crop_offset_x=0,
+            crop_offset_y=0,
             crop_width=200,
             crop_height=200,
             gain=2,

diff --git a/src/aind_data_schema/components/devices.py b/src/aind_data_schema/components/devices.py
@@ -325,6 +325,8 @@ class Detector(Device):
     bin_height: Optional[int] = Field(default=None, title="Bin height")
     bin_unit: SizeUnit = Field(default=SizeUnit.PX, title="Bin size unit")
     gain: Optional[Decimal] = Field(default=None, title="Gain")
+    crop_offset_x: Optional[int] = Field(default=None, title="Crop offset x")
+    crop_offset_y: Optional[int] = Field(default=None, title="Crop offset y")
     crop_width: Optional[int] = Field(default=None, title="Crop width")
     crop_height: Optional[int] = Field(default=None, title="Crop width")
     crop_unit: SizeUnit = Field(default=SizeUnit.PX, title="Crop size unit")