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

Fixing docstrings for camera stage mapping changes.

Browse source
This commit is contained in:
Julian Stirling 2025-07-13 23:53:44 +01:00
parent 531e5c27b2
commit 705cf73173
2 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/openflexure_microscope_server/things/camera_stage_mapping.py
View file

@ -62,9 +62,10 @@ class RecordedMove:
""" """
def __init__(self, stage: Stage): def __init__(self, stage: Stage):
"""Set the movement function to be wrapped. """Set the stage client used for for movement.
:param move_function: the movement function to be wrapped :param stage: the stage client to be used. ``stage.move_to_xyz_position`` will
be called whenever the instance is called.
""" """
self._stage: Stage = stage self._stage: Stage = stage
self._current_position: Optional[CoordinateType] = None self._current_position: Optional[CoordinateType] = None

4
src/openflexure_microscope_server/things/stage/__init__.py
View file

@ -105,6 +105,10 @@ class BaseStage(lt.Thing):
) -> None: ) -> None:
"""Move to the location specified by an (x, y, z) tuple. """Move to the location specified by an (x, y, z) tuple.
:param cancel: A cancel hook for cancelling the move. This dependency should be
injected automatically by LabThings-FastAPI
:param xyz_pos: The (x, y, z) position to move to.
:raises KeyError: if this stage does not have axes named "x", "y", and "z". :raises KeyError: if this stage does not have axes named "x", "y", and "z".
This method is provides the interface expected by the camera_stage_mapping. This method is provides the interface expected by the camera_stage_mapping.