openflexure_microscope_server.scan_directories

module documentation
(source)

Functionality to manage file system operations for scan directories.

Class BaseScanData Data about a scan not including workflow specific data.
Class HistoricScanData A Model for the scan data that has been loaded from disk.
Class ScanDirectory A class for handling interactions with scan directories.
Class ScanGalleryDBEngine The database engine to back gallery interactions for scans.
Class ScanGalleryInfo Summary information for the UI about a scan folder.
Function get_files_in_zip List the relative paths of all files and folders in the zip folder specified.
Function latest_scan_preview Return the path of the latest preview from a scan or None if not available.
Constant IMAGE_REGEX Undocumented
Constant IMG_DIR_NAME Undocumented
Constant LOGGER Undocumented
Constant SCAN_DATA_FILENAME Undocumented
Constant SCAN_DATA_SCHEMA_VERSION Undocumented
Constant SCAN_ZERO_PAD_DIGITS Undocumented
Constant STITCH_REGEX Undocumented
def get_files_in_zip(zip_path: str) -> list[str]: (source)

List the relative paths of all files and folders in the zip folder specified.

def latest_scan_preview(scan_name: str, base_dir: str) -> str | None: (source)

Return the path of the latest preview from a scan or None if not available.

IMAGE_REGEX = (source)

Undocumented

Value
re.compile(r'-?[0-9]+_-?[0-9]+\.jpe?g$')
IMG_DIR_NAME: str = (source)

Undocumented

Value
'images'
LOGGER = (source)

Undocumented

Value
logging.getLogger(__name__)
SCAN_DATA_FILENAME: str = (source)

Undocumented

Value
'scan_data.json'
SCAN_DATA_SCHEMA_VERSION: int = (source)

Undocumented

Value
2
SCAN_ZERO_PAD_DIGITS: int = (source)

Undocumented

Value
4
STITCH_REGEX = (source)

Undocumented

Value
re.compile(r'stitched\.jpe?g$')