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

Added docstring for measure_settling_time and hold

Browse source
This commit is contained in:
Joe Knapper 2022-01-11 15:46:15 +00:00
parent ecbdd8a5bf
commit 2d494b41d9
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
openflexure_microscope/api/default_extensions/autofocus.py
View file

@ -46,6 +46,8 @@ class JPEGSharpnessMonitor:
self.camera.stream.reset_tracking() self.camera.stream.reset_tracking()
def hold(self, delay: int = 5): def hold(self, delay: int = 5):
"""Run time.sleep for delay seconds,
while monitoring the JPEG frame size of the stream"""
self.camera.stream.start_tracking() self.camera.stream.start_tracking()
self.stage_times.append(time.time()) self.stage_times.append(time.time())
self.stage_positions.append(self.stage.position) self.stage_positions.append(self.stage.position)
@ -536,7 +538,7 @@ class AutofocusExtension(BaseExtension):
} }
) )
def measure_settling_time(self, microscope: Optional[Microscope] = None, delay: int = 2, dz: int = 400) -> Dict[str, np.ndarray]: def measure_settling_time(self, microscope: Optional[Microscope] = None, delay: int = 2, dz: int = 400) -> Dict[str, np.ndarray]:
"""Make a Z move down then up, then monitor sharpness. """Make a Z move down then up by dz, then pause for delay while monitoring sharpness.
This is useful so we can see how long we need to wait for the sharpness value to converge""" This is useful so we can see how long we need to wait for the sharpness value to converge"""
if not microscope: if not microscope:
microscope = find_microscope_with_real_stage() microscope = find_microscope_with_real_stage()