Finish setting up an ophyd_async OAV #857
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #857 +/- ##
==========================================
+ Coverage 95.53% 95.61% +0.07%
==========================================
Files 124 125 +1
Lines 5313 5246 -67
==========================================
- Hits 5076 5016 -60
+ Misses 237 230 -7 ☔ View full report in Codecov by Sentry. |
| self.color_mode = epics_signal_rw(ColorMode, "GC_BalRatioSelector") | ||
| self.acquire_period = epics_signal_rw(float, "AcquirePeriod") | ||
| self.acquire_time = epics_signal_rw(float, "AcquireTime") | ||
| self.gain = epics_signal_rw(float, "Gain") | ||
|
|
||
| self.array_size_x = epics_signal_r(int, "ArraySizeX_RBV") | ||
| self.array_size_y = epics_signal_r(int, "ArraySizeY_RBV") |
There was a problem hiding this comment.
Must: these aren't connecting in dodal connect i03 as they need the PV prefix
| self.x_size = epics_signal_r(int, prefix + "ArraySize1_RBV") | ||
| self.y_size = epics_signal_r(int, prefix + "ArraySize2_RBV") |
There was a problem hiding this comment.
Must: these aren't connecting in dodal connect i03 as you're missing a colon
| # TODO check type of these two | ||
| self.input_rbpv = epics_signal_r(str, prefix + "NDArrayPort_RBV") | ||
| self.input_plugin = epics_signal_rw(str, prefix + "NDArrayPort") |
There was a problem hiding this comment.
Should: These two PVs aren't used anyway, lets just remove them
| await self.last_saved_path.set(path, wait=True) | ||
|
|
||
| @AsyncStatus.wrap | ||
| async def trigger(self): | ||
| """This takes a snapshot image from the MJPG stream and send it to the | ||
| post_processing method, expected to be implemented by a child of this class. | ||
|
|
||
| It is the responsibility of the child class to save any resulting images. |
There was a problem hiding this comment.
Nit: by calling _save_image
| if not response.ok: | ||
| LOGGER.error( | ||
| f"OAV responded with {response.status}: {response.reason}." | ||
| ) | ||
| raise ClientConnectionError( | ||
| f"OAV responded with {response.status}: {response.reason}." | ||
| ) |
There was a problem hiding this comment.
Should: I think we can just do response.raise_for_status() or actually ClientSession(raise_for_status=True)
There was a problem hiding this comment.
I tried using this response.raise_for_status() and couldn't make it work, all the tests kept failing because they couldn't get past it - even when mocking it. Haven't managed to figure out why yet but this at least did the job. Didn't know it could be passed as an argument to ClientSession so will try that
src/dodal/devices/oav/utils.py
Outdated
| ) -> np.ndarray: | ||
| beam_distance_px: Pixel = oav_params.calculate_beam_distance(*pixel) | ||
| beam_distance_px: Pixel = calculate_beam_distance((beam_centre), *pixel) |
There was a problem hiding this comment.
Nit: These brackets seem unrequired
system_tests/test_oav_system.py
Outdated
| oav_config = OAVConfig(ZOOM_LEVELS_XML, DISPLAY_CONFIGURATION) | ||
| async with DeviceCollector(): | ||
| oav = OAV("", config=oav_config, name="oav") | ||
| await oav.connect() |
There was a problem hiding this comment.
Should: DeviceCollector already does the connect for you
| autospec=True, | ||
| ) | ||
| @patch("dodal.devices.areadetector.plugins.MJPG.Image") | ||
| async def test_snapshot_trigger_fails_in_post_processing_withouth_raising_error( |
There was a problem hiding this comment.
Should: I also think we probably do want it to raise
| # Set new directory and test that it's created | ||
| set_mock_value(snapshot.directory, "new_dir") | ||
|
|
||
| await snapshot.trigger() | ||
|
|
||
| mock_mkdir.assert_called_once() |
There was a problem hiding this comment.
Nit: I would test this in a separate test that's just testing a new folder is created i.e. like test_given_directory_not_existing_when_snapshot_triggered_then_directory_created
| mock_get.return_value.__aenter__.return_value = (mock_response := AsyncMock()) | ||
| mock_response.ok = True | ||
| mock_response.read.return_value = (test_data := b"TEST") | ||
|
|
||
| mock_aio_open = mock_aiofiles.open | ||
| mock_aio_open.return_value.__aenter__.return_value = (mock_file := AsyncMock()) | ||
|
|
||
| mock_open = patch_image.open | ||
| mock_open.return_value.__aenter__.return_value = test_data |
There was a problem hiding this comment.
Should: You do this mocking a few times, I think pull it into a helper function
| allowed_zoom_levels = await self._get_allowed_zoom_levels() | ||
| if level_to_set not in allowed_zoom_levels: | ||
| raise ZoomLevelNotFoundError( | ||
| f"{level_to_set} not found, expected one of {allowed_zoom_levels}" | ||
| ) | ||
| await self.level.set(level_to_set, wait=True) |
There was a problem hiding this comment.
I think long term we shouldn't be doing this check. I've added #884
| image, top_left_x, top_left_y, box_witdh, num_boxes_x, num_boxes_y | ||
| ) | ||
|
|
||
| path = path_join(directory_str, f"{filename_str}_outer_overlay.png") |
There was a problem hiding this comment.
Could: We could reuse the IMG_FORMAT for this
| image, top_left_x, top_left_y, box_witdh, num_boxes_x, num_boxes_y | ||
| ) | ||
|
|
||
| path = path_join(directory_str, f"{filename_str}_grid_overlay.png") |
There was a problem hiding this comment.
Could: As above, we could use IMG_FORMAT
Closes #716
Closes #824
Instructions to reviewer on how to test:
Checks for reviewer
dodal connect ${BEAMLINE}