openflexure_microscope_server.background_detect.BackgroundDetectorStatus

class documentation

class BackgroundDetectorStatus(BaseModel): (source)

The status information about a background detector instance needed for the GUI.

Each BackgroundDetectAlgorithm must be able to return one of these models when status is called.

Class Variable	`ready`	True if ready to be used, if False this detector isn't initialised for use.
Class Variable	`settings`	The settings for the current background detect Algorithm. These are a dictionary dumped from the base model.
Class Variable	`settings_schema`	The schema for the settings for the current background detect Algorithm.

ready: bool = (source) ¶

True if ready to be used, if False this detector isn't initialised for use.

This could be called has_background_data or similar, but the more generic ready is used in case more complex methods are added in the future, which need different initialisation.

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

The settings for the current background detect Algorithm. These are a dictionary dumped from the base model.

settings_schema: dict[str, Any] = (source) ¶

The schema for the settings for the current background detect Algorithm.

This is reported so that the UI can dynamically create a UI for any background detector algorithm.