openflexure_microscope_server.scan_directories.HistoricScanData

class documentation

class HistoricScanData(BaseScanData): (source)

View In Hierarchy

A Model for the scan data that has been loaded from disk.

Any workflow specific settings are loaded as an arbitrary dictionary. Other settings such as those which are needed for the UI or stitching are loaded and validated by the parent class BaseScanData.

Class Method coerce_legacy Coerce any scan data from before version 2 into the version 2 format.
Class Variable workflow_settings A dictionary of the settings for the workflow that was used workflow.

Inherited from BaseScanData:

Class Method parse_timedelta Validate a timedelta that may be a string in Hrs:Min:Sec format or "Unknown".
Class Method parse_timestamp Validate a timestamp that may be a string in Year-Month-Day_Hrs:Min:Sec format.
Class Method parse_unknown_as_none Validate the string "Unknown" as None.
Method serialize_none_as_unknown Serialise None as "Unknown" for a more human readable result.
Method serialize_timedelta Serialise timedelta to Hrs:Min:Sec (or "Unknown" if None).
Method serialize_timestamp Serialise timestamp to Year-Month-Day_Hrs:Min:Sec format.
Method validate_schema_version Validate the schema version is as the current one.
Class Variable duration The duration of the scan.
Class Variable image_count The number of images taken.
Class Variable model_config Undocumented
Class Variable save_resolution The resolution that scan images are saved at.
Class Variable scan_name The name of the scan i.e. scan_0001
Class Variable scan_result The result of the scan.
Class Variable start_time The time the scan started.
Class Variable starting_position The starting position in dictionary format.
Class Variable stitch_automatically Whether the scan is set to automatically stitch when complete.
Class Variable stitching_settings The data needed to stitch a scan.
Class Variable workflow The class name of the workflow Thing.
@model_validator(mode='before')
@classmethod
def coerce_legacy(cls, data: dict) -> dict: (source)

Coerce any scan data from before version 2 into the version 2 format.

workflow_settings: dict = (source)

A dictionary of the settings for the workflow that was used workflow.