openflexure_microscope_server.stitching.PreviewStitcher

class documentation

class PreviewStitcher(BaseStitcher): (source)

Constructor: PreviewStitcher(images_dir, overlap, correlation_resize)

View In Hierarchy

A stitcher for stitching an ongoing scan in preview mode.

Use start() to start a scan, and running to check if it is complete, or wait() to wait for it to complete.

The same stitcher object can be run multiple times to update the preview. However, one preview must finish before another can be started.

Method __init__ Initialise a preview stitcher.
Method start Start stitching a preview of the scan in a background subprocess.
Method wait Wait for this preview stitch to return.
Property running Whether the preview stitch is running in a subprocess.
Instance Variable _mode Undocumented
Instance Variable _popen_lock Undocumented
Instance Variable _popen_obj Undocumented

Inherited from BaseStitcher:

Method validate_path Check path is safe before making a command to run with subprocess.
Instance Variable correlation_resize Undocumented
Instance Variable images_dir Undocumented
Instance Variable min_overlap Undocumented
Property command The command to run with subprocess.Popen.
Instance Variable _extra_args Undocumented
def __init__(self, images_dir: str, *, overlap: float, correlation_resize: float): (source)
overrides openflexure_microscope_server.stitching.BaseStitcher.__init__

Initialise a preview stitcher.

All args except images_dir are positional only.

Parameters
images_dir:strThe images directory of the scan to stitch.
overlap:floatThe scan overlap.
correlation_resize:floatThe fraction to resize images by when correlating.
def start(self): (source)

Start stitching a preview of the scan in a background subprocess.

This uses popen and returns immediately.

def wait(self, cancel: lt.deps.CancelHook): (source)

Wait for this preview stitch to return.

Raises
InvocationCancelledErrorif the action is cancelled.
@property
running: bool = (source)

Whether the preview stitch is running in a subprocess.

_mode: str = (source)
overrides openflexure_microscope_server.stitching.BaseStitcher._mode

Undocumented

_popen_lock = (source)

Undocumented

_popen_obj: subprocess.Popen | None = (source)

Undocumented