Inheritance diagram for microscope.controllers.coolled._CoolLEDChannel:

Public Member Functions
None	__init__ (self, _CoolLEDConnection connection, str name, **kwargs)

typing.List[str]	get_status (self)

None	enable (self)

None	disable (self)

bool	get_is_on (self)

microscope.TriggerType	trigger_type (self)

microscope.TriggerMode	trigger_mode (self)

None	set_trigger (self, microscope.TriggerType ttype, microscope.TriggerMode tmode)

Public Member Functions inherited from microscope.abc.LightSource
float	power (self)

None	power (self, float power)

float	get_set_power (self)

Public Member Functions inherited from microscope.abc.TriggerTargetMixin
None	trigger (self)

Public Member Functions inherited from microscope.abc.Device
None	__del__ (self)

bool	get_is_enabled (self)

None	initialize (self)

None	shutdown (self)

None	add_setting (self, name, dtype, get_func, set_func, values, typing.Optional[typing.Callable[[], bool]] readonly=None)

	get_setting (self, str name)

	get_all_settings (self)

None	set_setting (self, str name, value)

	describe_setting (self, str name)

	describe_settings (self)

	update_settings (self, incoming, bool init=False)

Protected Member Functions
None	_do_shutdown (self)

float	_do_get_power (self)

None	_do_set_power (self, float power)

None	_do_trigger (self)

Protected Member Functions inherited from microscope.abc.LightSource
Protected Member Functions inherited from microscope.abc.TriggerTargetMixin
Protected Member Functions inherited from microscope.abc.Device
	_do_disable (self)

	_do_enable (self)

Protected Attributes
	_conn = _CoolLEDChannelConnection(connection, name)

bool	_should_be_on = False

Protected Attributes inherited from microscope.abc.LightSource
float	_set_point = 0.0

Protected Attributes inherited from microscope.abc.Device
dict	_settings = {}

Additional Inherited Members
Public Attributes inherited from microscope.abc.Device
bool	enabled = False

Detailed Description

Individual light devices that compose a CoolLED controller.

Definition at line 133 of file coolled.py.

Constructor & Destructor Documentation

◆ init()

None microscope.controllers.coolled._CoolLEDChannel.__init__	(		self,
		_CoolLEDConnection	connection,
		str	name,
		**	kwargs )

Reimplemented from microscope.abc.LightSource.

Definition at line 136 of file coolled.py.

    ) -> None:
        super().__init__(**kwargs)
        self._conn = _CoolLEDChannelConnection(connection, name)
        # If a channel is disabled ("unselected"), setting the trigger
        # type to software ("on") is not recorded and reverts back to
        # high ("off").  Because of this, we keep track of what
        # trigger type we want, i.e., should be "on" or "off", and
        # apply it when the channel is enabled.
        self._should_be_on = False
 
        # The channel may be "selected" (enabled) and "off" (trigger
        # type HIGH).  When we set the trigger type to software,
        # that's the same as setting it "on" which will make the
        # channel emit light.  Constructing this channel should not
        # accidentally mae it emit light so disable it firt.
        self.disable()
 
        # Default to software trigger type.
        self.set_trigger(
            microscope.TriggerType.SOFTWARE, microscope.TriggerMode.BULB
        )
 

Member Function Documentation

◆ _do_get_power()

float microscope.controllers.coolled._CoolLEDChannel._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented from microscope.abc.LightSource.

Definition at line 183 of file coolled.py.

    def _do_get_power(self) -> float:
        return self._conn.get_intensity() / 100.0
 

◆ _do_set_power()

None microscope.controllers.coolled._CoolLEDChannel._do_set_power	(		self,
		float	power )

protected

Internal function that actually sets the light source power.

This function will be called by the `power` attribute setter
after clipping the argument to the [0, 1] interval.

Reimplemented from microscope.abc.LightSource.

Definition at line 186 of file coolled.py.

    def _do_set_power(self, power: float) -> None:
        self._conn.set_intensity(int(power * 100.0))
 

◆ _do_shutdown()

None microscope.controllers.coolled._CoolLEDChannel._do_shutdown ( self )

protected

Private method - actual shutdown of the device.

Users should be calling :meth:`shutdown` and not this method.
Concrete implementations should implement this method instead
of `shutdown`.

Reimplemented from microscope.abc.Device.

Definition at line 160 of file coolled.py.

    def _do_shutdown(self) -> None:
        pass
 

◆ _do_trigger()

None microscope.controllers.coolled._CoolLEDChannel._do_trigger ( self )

protected

Actual trigger of the device.

Classes implementing this interface should implement this
method instead of `trigger`.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 228 of file coolled.py.

    def _do_trigger(self) -> None:
        raise microscope.IncompatibleStateError(
            "trigger does not make sense in trigger mode bulb, only enable"
        )
 
 

◆ disable()

None microscope.controllers.coolled._CoolLEDChannel.disable ( self )

Disable the device for a short period for inactivity.

Reimplemented from microscope.abc.Device.

Definition at line 175 of file coolled.py.

    def disable(self) -> None:
        self._conn.set_selected_state("X")
 

◆ enable()

None microscope.controllers.coolled._CoolLEDChannel.enable ( self )

Enable the device.

Reimplemented from microscope.abc.Device.

Definition at line 166 of file coolled.py.

    def enable(self) -> None:
        self._conn.set_selected_state("S")
        if self._should_be_on:
            # TriggerType.SOFTWARE
            self._conn.set_switch_state("N")
        else:
            # TriggerType.HIGH
            self._conn.set_switch_state("F")
 

◆ get_is_on()

bool microscope.controllers.coolled._CoolLEDChannel.get_is_on ( self )

Return True if the light source is currently able to produce light.

Reimplemented from microscope.abc.LightSource.

Definition at line 178 of file coolled.py.

    def get_is_on(self) -> bool:
        selected = self._conn.get_selected_state()
        assert selected in ["S", "X"]
        return selected == "S"
 

◆ get_status()

typing.List[str] microscope.controllers.coolled._CoolLEDChannel.get_status ( self )

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 163 of file coolled.py.

    def get_status(self) -> typing.List[str]:
        return []
 

◆ set_trigger()

None microscope.controllers.coolled._CoolLEDChannel.set_trigger	(		self,
		microscope.TriggerType	ttype,
		microscope.TriggerMode	tmode )

Set device for a specific trigger.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 210 of file coolled.py.

    ) -> None:
        if tmode is not microscope.TriggerMode.BULB:
            raise microscope.UnsupportedFeatureError(
                "the only trigger mode supported is 'bulb'"
            )
        if ttype is microscope.TriggerType.SOFTWARE:
            self._conn.set_switch_state("N")
            self._should_be_on = True
        elif ttype is microscope.TriggerType.HIGH:
            self._conn.set_switch_state("F")
            self._should_be_on = False
        else:
            raise microscope.UnsupportedFeatureError(
                "trigger type supported must be 'SOFTWARE' or 'HIGH'"
            )
 

◆ trigger_mode()

microscope.TriggerMode microscope.controllers.coolled._CoolLEDChannel.trigger_mode ( self )

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 207 of file coolled.py.

    def trigger_mode(self) -> microscope.TriggerMode:
        return microscope.TriggerMode.BULB
 

◆ trigger_type()

microscope.TriggerType microscope.controllers.coolled._CoolLEDChannel.trigger_type ( self )

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 190 of file coolled.py.

    def trigger_type(self) -> microscope.TriggerType:
        if self._conn.get_selected_state() == "S":
            # Channel is "selected" (enabled): get the answer from
            # switch state ("on" or "off").
            if self._conn.get_switch_state() == "N":
                return microscope.TriggerType.SOFTWARE
            else:
                return microscope.TriggerType.HIGH
        else:
            # Channel is "unselected" (disabled): trigger type will be
            # whatever we set it to when we enable it.
            if self._should_be_on:
                return microscope.TriggerType.SOFTWARE
            else:
                return microscope.TriggerType.HIGH
 

Member Data Documentation

◆ _conn

microscope.controllers.coolled._CoolLEDChannel._conn = _CoolLEDChannelConnection(connection, name)

protected

Definition at line 140 of file coolled.py.

◆ _should_be_on

bool microscope.controllers.coolled._CoolLEDChannel._should_be_on = False

protected

Definition at line 146 of file coolled.py.

The documentation for this class was generated from the following file:

BioImager/PythonMicroscope/microscope/controllers/coolled.py

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _do_get_power()

◆ _do_set_power()

◆ _do_shutdown()

◆ _do_trigger()

◆ disable()

◆ enable()

◆ get_is_on()

◆ get_status()

◆ set_trigger()

◆ trigger_mode()

◆ trigger_type()

Member Data Documentation

◆ _conn

◆ _should_be_on

◆ init()