openflexure_microscope_server.stitching.BaseStitcher

class documentation

class BaseStitcher: (source)

Known subclasses: openflexure_microscope_server.stitching.FinalStitcher, openflexure_microscope_server.stitching.PreviewStitcher

Constructor: BaseStitcher(images_dir, overlap, correlation_resize)

View In Hierarchy

A base stitching class for all stitchers. Don't initialise this directly.

The base class has no way to run the command. Child classes should either implement start, running, and wait methods if return after starting the subprocess and can be polled or waited on like a thread; or run if the the function blocks while the stitching subprocess is ongoing and return once complete.

Method	`__init__`	Initialise a stitcher.
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
Instance Variable	`_mode`	Undocumented

def __init__(self, images_dir: str, *, overlap: float, correlation_resize: float): (source) ¶

overridden in openflexure_microscope_server.stitching.FinalStitcher, openflexure_microscope_server.stitching.PreviewStitcher

Initialise a stitcher.

All args except images_dir are positional only.

Parameters
images_dir:`str`	The images directory of the scan to stitch.
overlap:`float`	The scan overlap.
correlation_resize:`float`	The fraction to resize images by when correlating.

def validate_path(self): (source) ¶

Check path is safe before making a command to run with subprocess.

This is essential for stopping arbitrary code execution.

Raises
`RuntimeError`	if inputs are unsafe.

correlation_resize = (source) ¶

Undocumented

images_dir = (source) ¶

Undocumented

min_overlap = (source) ¶

Undocumented

@property

command: list[str] = (source) ¶

The command to run with subprocess.Popen.

_extra_args: list = (source) ¶

overridden in openflexure_microscope_server.stitching.FinalStitcher

Undocumented

_mode: str = (source) ¶

overridden in openflexure_microscope_server.stitching.FinalStitcher, openflexure_microscope_server.stitching.PreviewStitcher

Undocumented