openflexure_microscope_server.things.smart_scan.ActiveScanData

class documentation

class ActiveScanData(scan_directories.BaseScanData): (source)

View In Hierarchy

A model for the scan data during an ongoing scan.

This differs from HistoricScanData as in this model workflow_settings are the model specified for the current ScanWorkflow. HistoricScanData loads workflow_settings into a dictionary.

Method set_final_data Set the final data for the scan, scan duration is automatically calculated.
Class Variable workflow_settings The settings for the ongoing workflow.
Instance Variable duration The duration of the scan.
Instance Variable scan_result The result of the scan.

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 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 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.
def set_final_data(self, result: str): (source)

Set the final data for the scan, scan duration is automatically calculated.

Parameters
result:strA string describing the result.
workflow_settings: AnyModel = (source)

The settings for the ongoing workflow.

duration = (source)
overrides openflexure_microscope_server.scan_directories.BaseScanData.duration

The duration of the scan.

This is automatically set when set_final_data() is run.

scan_result = (source)
overrides openflexure_microscope_server.scan_directories.BaseScanData.scan_result

The result of the scan.

This should be set with set_final_data() to ensure duration is set.