openflexure_microscope_server.things.background_detect.BackgroundDetectAlgorithm

class documentation

class BackgroundDetectAlgorithm(lt.Thing): (source)

Known subclasses: openflexure_microscope_server.things.background_detect.ChannelDeviationLUV, openflexure_microscope_server.things.background_detect.ColourChannelDetectLUV

Constructor: BackgroundDetectAlgorithm(thing_server_interface)

View In Hierarchy

The base class for defining background detect algorithms.

Method	`__init__`	Initialise and create the lock.
Method	`image_is_sample`	Label the current image as either background or sample.
Method	`set_background`	Use the input image to update the background data.
Class Variable	`display_name`	Undocumented
Property	`ready`	Whether the background detector is ready.
Property	`settings_ui`	A list of PropertyControl objects to create the settings in the UI.

def __init__(self, thing_server_interface: lt.ThingServerInterface): (source) ¶

Initialise and create the lock.

def image_is_sample(self, image: np.ndarray) -> tuple[bool, str]: (source) ¶

overridden in openflexure_microscope_server.things.background_detect.ChannelDeviationLUV, openflexure_microscope_server.things.background_detect.ColourChannelDetectLUV

Label the current image as either background or sample.

Returns
`tuple[bool, str]`	A tuple of the result (boolean), and explanation string. The explanation string is formatted so it can be added into a sentence such as `An action was taken because the image is {message}.`

def set_background(self, image: np.ndarray): (source) ¶

overridden in openflexure_microscope_server.things.background_detect.ChannelDeviationLUV, openflexure_microscope_server.things.background_detect.ColourChannelDetectLUV

Use the input image to update the background data.

Background data must be a Pydantic BaseModel.

display_name: str = (source) ¶

overridden in openflexure_microscope_server.things.background_detect.ChannelDeviationLUV, openflexure_microscope_server.things.background_detect.ColourChannelDetectLUV

Undocumented

@lt.property

ready: bool = (source) ¶

overridden in openflexure_microscope_server.things.background_detect.ChannelDeviationLUV, openflexure_microscope_server.things.background_detect.ColourChannelDetectLUV

Whether the background detector is ready.

@lt.property

settings_ui: list[PropertyControl] = (source) ¶

overridden in openflexure_microscope_server.things.background_detect.ChannelDeviationLUV, openflexure_microscope_server.things.background_detect.ColourChannelDetectLUV

A list of PropertyControl objects to create the settings in the UI.