module documentation

The core sample scanning functionality for the OpenFlexure Microscope.

SmartScan provides sample scanning functionality including automatic background detection (via the CameraThing) and automatic path planning via scan_planners. It manages the directories of past scans via scan_directories. It also controls external processes for live stitching composite images, and the creation of the final stitched images.

Class SmartScanThing A Thing for scanning samples and interacting with past scans.
Exception ScanNotRunningError Exception called when scan not running that requires a scan to be running.
Variable AutofocusDep Undocumented
Variable CSMDep Undocumented
Variable JPEGBlob Undocumented
Variable ZipBlob Undocumented
Function _scan_running Decorate a method so that it will error if a scan is not running.
AutofocusDep = (source)

Undocumented

Undocumented

JPEGBlob = (source)

Undocumented

Undocumented

def _scan_running(method): (source)

Decorate a method so that it will error if a scan is not running.

This decorator is used by all methods in SmartScanThing that are using the variables set for the scan. It will throw a runtime error if self._scan_logger is not set, as all scan variables are set at the same time and released with the lock