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

Update docstrings in response to review.

Browse source
This commit is contained in:
Julian Stirling 2025-10-17 15:26:39 +01:00
parent 30217a4c38
commit a935105e56
1 changed files with 15 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/openflexure_microscope_server/things/stage_measure.py
View file

@ -1,14 +1,14 @@
"""File contains all the functions used to measure the range of motion. """File contains all the functions used to measure the range of motion.
The range of motion is measured by first taking 5 'medium' sized steps which gives enough positions The range of motion is measured by first taking 5 'medium' sized steps which gives
to predict future z positions. Next, one 'big' step is taken followed by 3 enough positions to predict future z positions. Next, one 'big' step is taken followed
'small' steps to test that the stage is still moving as expected and has not reached the edge. by 3 'small' steps to test that the stage is still moving as expected and has not
Once the edge has been found and to account for the possibility that a 'big' reached the edge. Once the edge has been found and to account for the possibility that
step was taken just before the edge was reached, the stage is moved in a sequence the edge was reached during a "big" step, the stage is moved in a sequence of steps
of increasing pixel sizes in the opposite direction until motion is detected. This is (incrementing in size) in the opposite direction until motion is detected. This is
position is taken as the true final position. position is taken as the true final position.
Throughout the test, parasitic motion(motion in the axis not being measured) Throughout the test, parasitic motion (motion in the axis not being measured)
is tracked and an error is raised if it exceeds a minimum amount. Currently is tracked and an error is raised if it exceeds a minimum amount. Currently
this is 10% of the expected motion is the measured axis. this is 10% of the expected motion is the measured axis.
""" """
@ -211,7 +211,11 @@ class RangeofMotionThing(lt.Thing):
direction: Literal[1, -1], direction: Literal[1, -1],
rom_deps: RomDeps, rom_deps: RomDeps,
) -> dict: ) -> dict:
"""Move in one direction until no movement is detected. """Move in one direction until movement per step decreases significantly.
This should move until the edge of the stage. Once the edge is reached there
will be some movement as there is no hard stop, but it will reduce
significantly.
:param rom_deps: All dependencies that were passed to the calling Action :param rom_deps: All dependencies that were passed to the calling Action
:param axis: The axis which is being measured. This must be 'x' or 'y'. :param axis: The axis which is being measured. This must be 'x' or 'y'.
@ -376,8 +380,9 @@ class RangeofMotionThing(lt.Thing):
An image is taken before and after each move to check has moved as far as it An image is taken before and after each move to check has moved as far as it
should. If the offset (calculated by cross correlation) is less than expected, should. If the offset (calculated by cross correlation) is less than expected,
3 attempts are made to refocus the image to ensure that image quality is not 3 attempts are made to refocus the image to ensure that image quality is not
causing the offset to mistakenly be reported as too low be unsuccessful. If the causing the offset to mistakenly be reported as a low value. If the
calculated offset is still too low then the edge is found. calculated offset is still too low then this is taken as an indication that the
edge has been found.
:param axis: The axis which is being measured. This must be 'x' or 'y'. :param axis: The axis which is being measured. This must be 'x' or 'y'.
:param direction: The direction the stage moves. :param direction: The direction the stage moves.