openflexure_microscope_server.things.illumination.Illumination

class documentation

class Illumination(lt.Thing): (source)

Known subclasses: openflexure_microscope_server.things.illumination.SangaIllumination, openflexure_microscope_server.things.illumination.SimulatorIllumination

View In Hierarchy

Base class for an illumination controller.

Method	`flash`	Flash the illumination source.
Method	`set_led`	Set the LED to on or off.

@lt.action

def flash(self, number_of_flashes: int = 10, dt: float = 0.5): (source) ¶

Flash the illumination source.

Parameters
number_of_flashes:`int`	Number of times to flash the LED.
dt:`float`	Flash duration in seconds.

@lt.action

def set_led(self, led_on: bool = True): (source) ¶

overridden in openflexure_microscope_server.things.illumination.SangaIllumination, openflexure_microscope_server.things.illumination.SimulatorIllumination

Set the LED to on or off.