rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Cleaning up workflows and fixing tests.

Browse source
This commit is contained in:
Julian Stirling 2026-02-11 10:05:31 +00:00
parent 86fa48fb9b
commit 351a66a42c
2 changed files with 37 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/openflexure_microscope_server/scan_planners.py
View file

@ -318,9 +318,9 @@ class RectGridPlanner(ScanPlanner):
def _parse(self, planner_settings: Optional[dict] = None) -> None: def _parse(self, planner_settings: Optional[dict] = None) -> None:
expected_keys = ["dx", "dy"] expected_keys = ["dx", "dy"]
invalid_msg = "RectGridPlanner requires planner_settings with keys: " invalid_msg = "RectGridPlanner requires planner_settings with keys: "
if not planner_settings: if not planner_settings or not all(
raise ValueError(invalid_msg + ",".join(expected_keys)) k in planner_settings for k in expected_keys
if not all(k in planner_settings for k in expected_keys): ):
raise KeyError(invalid_msg + ",".join(expected_keys)) raise KeyError(invalid_msg + ",".join(expected_keys))
self._dx = int(planner_settings["dx"]) self._dx = int(planner_settings["dx"])
@ -623,7 +623,7 @@ class RegularGridPlanner(RectGridPlanner):
super()._parse(planner_settings) super()._parse(planner_settings)
expected_keys = ["x_count", "y_count", "style"] expected_keys = ["x_count", "y_count", "style"]
invalid_msg = "SnakeScan requires planner_settings with keys: " invalid_msg = "RegularGrid requires planner_settings with keys: "
if not planner_settings or not all( if not planner_settings or not all(
k in planner_settings for k in expected_keys k in planner_settings for k in expected_keys
): ):

48
tests/unit_tests/test_scan_planners.py
View file

@ -89,8 +89,8 @@ def test_bad_smart_spiral_settings():
initial_position = (100, 50) initial_position = (100, 50)
# Class init should raise error if no planner_settings dictionary set # Class init should raise error if no planner_settings dictionary set
msg = "RectangleScan requires planner_settings with keys" msg = "RectGridPlanner requires planner_settings with keys"
with pytest.raises(ValueError, match=msg): with pytest.raises(KeyError, match=msg):
scan_planners.SmartSpiral(initial_position=initial_position) scan_planners.SmartSpiral(initial_position=initial_position)
planner_settings = {"dx": 50, "dy": 50, "max_dist": 10000} planner_settings = {"dx": 50, "dy": 50, "max_dist": 10000}
@ -317,12 +317,18 @@ def test_example_smart_spiral():
assert planner.imaged_locations == expected_planner.imaged_locations assert planner.imaged_locations == expected_planner.imaged_locations
def test_snake_scan_basic_grid(): def test_snake_planner_basic_grid():
"""Check that SnakeScan generates a single point for a 1x1 scan.""" """Check that snake scan planner generates a single point for a 1x1 scan."""
initial_position = (100, 50) initial_position = (100, 50)
planner_settings = {"dx": 100, "dy": 100, "x_count": 1, "y_count": 1} planner_settings = {
"dx": 100,
"dy": 100,
"x_count": 1,
"y_count": 1,
"style": "snake",
}
planner = scan_planners.SnakeScan( planner = scan_planners.RegularGridPlanner(
initial_position=initial_position, initial_position=initial_position,
planner_settings=planner_settings, planner_settings=planner_settings,
) )
@ -352,11 +358,17 @@ def test_snake_scan_basic_grid():
def test_snake_scan_basic_length(): def test_snake_scan_basic_length():
"""SnakeScan should generate the correct number of locations.""" """Snake scan planner should generate the correct number of locations."""
initial_position = (100, 50) initial_position = (100, 50)
planner_settings = {"dx": 100, "dy": 100, "x_count": 3, "y_count": 4} planner_settings = {
"dx": 100,
"dy": 100,
"x_count": 3,
"y_count": 4,
"style": "snake",
}
planner = scan_planners.SnakeScan( planner = scan_planners.RegularGridPlanner(
initial_position=initial_position, initial_position=initial_position,
planner_settings=planner_settings, planner_settings=planner_settings,
) )
@ -369,9 +381,15 @@ def test_snake_scan_basic_length():
def test_snake_scan_ordering(): def test_snake_scan_ordering():
"""Test that snake scan returns a path in the right order.""" """Test that snake scan returns a path in the right order."""
initial_position = (0, 0) initial_position = (0, 0)
planner_settings = {"dx": 10, "dy": 10, "x_count": 4, "y_count": 3} planner_settings = {
"dx": 10,
"dy": 10,
"x_count": 4,
"y_count": 3,
"style": "snake",
}
planner = scan_planners.SnakeScan( planner = scan_planners.RegularGridPlanner(
initial_position=initial_position, initial_position=initial_position,
planner_settings=planner_settings, planner_settings=planner_settings,
) )
@ -399,9 +417,9 @@ def test_snake_scan_ordering():
def test_snake_scan_single_row(): def test_snake_scan_single_row():
"""Test edge case of a single row scan.""" """Test edge case of a single row scan."""
initial_position = (0, 0) initial_position = (0, 0)
planner_settings = {"dx": 5, "dy": 5, "x_count": 4, "y_count": 1} planner_settings = {"dx": 5, "dy": 5, "x_count": 4, "y_count": 1, "style": "snake"}
planner = scan_planners.SnakeScan( planner = scan_planners.RegularGridPlanner(
initial_position=initial_position, initial_position=initial_position,
planner_settings=planner_settings, planner_settings=planner_settings,
) )
@ -412,9 +430,9 @@ def test_snake_scan_single_row():
def test_snake_scan_single_column(): def test_snake_scan_single_column():
"""Test edge case of a single column scan.""" """Test edge case of a single column scan."""
initial_position = (0, 0) initial_position = (0, 0)
planner_settings = {"dx": 5, "dy": 5, "x_count": 1, "y_count": 4} planner_settings = {"dx": 5, "dy": 5, "x_count": 1, "y_count": 4, "style": "snake"}
planner = scan_planners.SnakeScan( planner = scan_planners.RegularGridPlanner(
initial_position=initial_position, initial_position=initial_position,
planner_settings=planner_settings, planner_settings=planner_settings,
) )