Update language in BaseStitcher to clarify that the stitching uses subprocess not threading

This commit is contained in:
Julian Stirling 2025-08-07 12:06:58 +01:00
parent cd311f08bf
commit 7727d0a51d

View file

@ -47,8 +47,10 @@ class BaseStitcher:
"""A base stitching class for all stitchers. Don't initialise this directly. """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 The base class has no way to run the command. Child classes should either implement
a ``start``, ``running``, and ``wait`` methods if they stitch in a thread, or ``run`` a ``start``, ``running``, and ``wait`` methods if return after starting the
if they stitch in this thread and return once complete. 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.
""" """
def __init__(self, images_dir: str, *, overlap: float, correlation_resize: float): def __init__(self, images_dir: str, *, overlap: float, correlation_resize: float):