openflexure_microscope_server.things.smart_scan.LiveScanDetails

class documentation

class LiveScanDetails(BaseModel): (source)

View In Hierarchy

Details of ongoing scan used for the UI.

This is also used to populate the "current scan settings" info modal in the scan tab, so it contains the workflow name and strings / dicts of the workflow/stitching settings.

duration_seconds is monitored server-side and polled with other details, rather than being monitored in the front end while also polling the back end.

Method update_as_run_starts Update the live details as the scan starts.
Method update_duration Update the duration using a monotonic clock.
Class Variable image_count Undocumented
Class Variable name Undocumented
Class Variable stitch_timestamp Undocumented
Instance Variable duration_seconds Undocumented
Instance Variable save_resolution Undocumented
Instance Variable scan_phase Undocumented
Instance Variable settings Undocumented
Instance Variable stitching_settings Undocumented
Instance Variable workflow Undocumented
def update_as_run_starts(self, scan_data: ActiveScanData): (source)

Update the live details as the scan starts.

Parameters
scan_data:ActiveScanDataThe ActiveScanData for the scan that is starting.
def update_duration(self, start_monotonic: float): (source)

Update the duration using a monotonic clock.

Parameters
start_monotonic:floatThe time the scan started according to the monotonic clock.
image_count: int = (source)

Undocumented

name: str = (source)

Undocumented

stitch_timestamp: float | None = (source)

Undocumented

duration_seconds: float | None = (source)

Undocumented

save_resolution: tuple[int, int] | None = (source)

Undocumented

scan_phase: Literal['Setup', 'Scanning', 'Stitching', 'Complete'] = (source)

Undocumented

settings: dict[str, Any] | None = (source)

Undocumented

stitching_settings: dict[str, Any] | None = (source)

Undocumented

workflow: str | None = (source)

Undocumented