Move transmission to the experiment param base class

src/dodal/devices/fast_grid_scan.py

@@ -14,13 +14,13 @@
     Signal,
 )
 from ophyd.status import DeviceStatus, StatusBase
-from pydantic import BaseModel, validator
+from pydantic import validator
 from pydantic.dataclasses import dataclass
 
 from dodal.devices.motors import XYZLimitBundle
 from dodal.devices.status import await_value
 from dodal.log import LOGGER
-from dodal.parameters.experiment_parameter_base import AbstractExperimentParameterBase
+from dodal.parameters.experiment_parameter_base import AbstractExperimentWithBeamParams
 
 
 @dataclass
@@ -44,7 +44,7 @@ def is_within(self, steps):
         return 0 <= steps <= self.full_steps
 
 
-class GridScanParamsCommon(BaseModel, AbstractExperimentParameterBase):
+class GridScanParamsCommon(AbstractExperimentWithBeamParams):
     """
     Common holder class for the parameters of a grid scan in a similar
     layout to EPICS. The parameters and functions of this class are common

src/dodal/parameters/experiment_parameter_base.py

@@ -1,7 +1,15 @@
 from abc import ABC, abstractmethod
 
+from pydantic import BaseModel
+
+
+class AbstractExperimentParameterBase(BaseModel, ABC):
+    pass
+
+
+class AbstractExperimentWithBeamParams(AbstractExperimentParameterBase):
+    transmission_fraction: float
 
-class AbstractExperimentParameterBase(ABC):
     @abstractmethod
     def get_num_images(self) -> int:
         pass

tests/devices/system_tests/test_gridscan_system.py

@@ -32,7 +32,12 @@ def test_when_program_data_set_and_staged_then_expected_images_correct(
     fast_grid_scan: FastGridScan,
 ):
     RE = RunEngine()
-    RE(set_fast_grid_scan_params(fast_grid_scan, GridScanParams(x_steps=2, y_steps=2)))
+    RE(
+        set_fast_grid_scan_params(
+            fast_grid_scan,
+            GridScanParams(transmission_fraction=0.01, x_steps=2, y_steps=2),
+        )
+    )
     assert fast_grid_scan.expected_images.get() == 2 * 2
     fast_grid_scan.stage()
     assert fast_grid_scan.position_counter.get() == 0
@@ -44,7 +49,8 @@ def test_given_valid_params_when_kickoff_then_completion_status_increases_and_fi
 ):
     def set_and_wait_plan(fast_grid_scan: FastGridScan):
         yield from set_fast_grid_scan_params(
-            fast_grid_scan, GridScanParams(x_steps=3, y_steps=3)
+            fast_grid_scan,
+            GridScanParams(transmission_fraction=0.01, x_steps=3, y_steps=3),
         )
         yield from wait_for_fgs_valid(fast_grid_scan)
 

tests/devices/unit_tests/test_gridscan.py

@@ -83,7 +83,12 @@ def run_test_on_complete_watcher(
     RE = RunEngine()
     RE(
         set_fast_grid_scan_params(
-            fast_grid_scan, GridScanParams(x_steps=num_pos_1d, y_steps=num_pos_1d)
+            fast_grid_scan,
+            GridScanParams(
+                x_steps=num_pos_1d,
+                y_steps=num_pos_1d,
+                transmission_fraction=0.01,
+            ),
         )
     )
 
@@ -146,7 +151,10 @@ def test_running_finished_with_all_images_done_then_complete_status_finishes_not
     RE = RunEngine()
     RE(
         set_fast_grid_scan_params(
-            fast_grid_scan, GridScanParams(x_steps=num_pos_1d, y_steps=num_pos_1d)
+            fast_grid_scan,
+            GridScanParams(
+                transmission_fraction=0.01, x_steps=num_pos_1d, y_steps=num_pos_1d
+            ),
         )
     )
 
@@ -212,7 +220,9 @@ def test_within_limits_check(position, expected_in_limit):
 )
 def test_scan_within_limits_1d(start, steps, size, expected_in_limits):
     motor_bundle = create_motor_bundle_with_limits(0.0, 10.0)
-    grid_params = GridScanParams(x_start=start, x_steps=steps, x_step_size=size)
+    grid_params = GridScanParams(
+        transmission_fraction=0.01, x_start=start, x_steps=steps, x_step_size=size
+    )
     assert grid_params.is_valid(motor_bundle.get_xyz_limits()) == expected_in_limits
 
 
@@ -229,6 +239,7 @@ def test_scan_within_limits_2d(
 ):
     motor_bundle = create_motor_bundle_with_limits(0.0, 10.0)
     grid_params = GridScanParams(
+        transmission_fraction=0.01,
         x_start=x_start,
         x_steps=x_steps,
         x_step_size=x_size,
@@ -285,6 +296,7 @@ def test_scan_within_limits_3d(
 ):
     motor_bundle = create_motor_bundle_with_limits(0.0, 10.0)
     grid_params = GridScanParams(
+        transmission_fraction=0.01,
         x_start=x_start,
         x_steps=x_steps,
         x_step_size=x_size,
@@ -303,6 +315,7 @@ def test_scan_within_limits_3d(
 @pytest.fixture
 def grid_scan_params():
     yield GridScanParams(
+        transmission_fraction=0.01,
         x_steps=10,
         y_steps=15,
         z_steps=20,
@@ -404,8 +417,14 @@ def test_given_x_y_z_steps_when_full_number_calculated_then_answer_is_as_expecte
 )
 def test_non_test_integer_dwell_time(test_dwell_times, expected_dwell_time_is_integer):
     if expected_dwell_time_is_integer:
-        params = GridScanParams(dwell_time_ms=test_dwell_times)
+        params = GridScanParams(
+            dwell_time_ms=test_dwell_times,
+            transmission_fraction=0.01,
+        )
         assert params.dwell_time_ms == test_dwell_times
     else:
         with pytest.raises(ValueError):
-            GridScanParams(dwell_time_ms=test_dwell_times)
+            GridScanParams(
+                dwell_time_ms=test_dwell_times,
+                transmission_fraction=0.01,
+            )

tests/devices/unit_tests/test_panda_gridscan.py

@@ -67,7 +67,12 @@ def test_running_finished_with_all_images_done_then_complete_status_finishes_not
     RE = RunEngine()
     RE(
         set_fast_grid_scan_params(
-            fast_grid_scan, PandAGridScanParams(x_steps=num_pos_1d, y_steps=num_pos_1d)
+            fast_grid_scan,
+            PandAGridScanParams(
+                x_steps=num_pos_1d,
+                y_steps=num_pos_1d,
+                transmission_fraction=0.01,
+            ),
         )
     )