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

Update scan_planner module docstring

Browse source
This commit is contained in:
Julian Stirling 2026-02-11 10:37:34 +00:00
parent 351a66a42c
commit af5c8f01da
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
src/openflexure_microscope_server/scan_planners.py
View file

@ -1,8 +1,13 @@
"""Functionality for planning scan routes.
A scan route can be planned by a ScanPlanner class currently there
is only one type the SmartSpiral. More can be added using by
subclassing the ScanPlanner
A scan route can be planned by a ScanPlanner. There is a base class ``ScanPlanner``,
and then a child class that is still generic called RectGridPlanner that helps planning
anything where the movements are on a regtangular grid. RectGridPlanner has two usable
child classes:
* SmartSpiral - For spiralling around a samples but adjusting when background is
detected
* RegularGridPlanner - For Raster and Snake scanning.
"""
# Future annotations needed for typhinting same class in __eq__ method. Other option