microscope.controllers.zaber._ZaberLED Class Reference

Inheritance diagram for microscope.controllers.zaber._ZaberLED:

Public Member Functions
None	__init__ (self, _ZaberDeviceConnection dev_conn, int channel)
typing.List[str]	get_status (self)
bool	get_is_on (self)
Public Member Functions inherited from microscope._utils.OnlyTriggersBulbOnSoftwareMixin
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.TriggerTargetMixin
None	trigger (self)
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.Device
None	__del__ (self)
bool	get_is_enabled (self)
None	disable (self)
None	enable (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)
bool	_do_enable (self)
None	_do_disable (self)
float	_do_get_power (self)
None	_do_set_power (self, float power)
Protected Member Functions inherited from microscope._utils.OnlyTriggersBulbOnSoftwareMixin
None	_do_trigger (self)
Protected Member Functions inherited from microscope.abc.TriggerTargetMixin
Protected Member Functions inherited from microscope.abc.LightSource
Protected Member Functions inherited from microscope.abc.Device

Protected Attributes
	_dev_conn = dev_conn
	_channel = channel
	_max_flux = self._dev_conn.get_lamp_max_flux(self._channel)
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

A single LED from a LED controller.

Definition at line 421 of file zaber.py.

Constructor & Destructor Documentation

__init__()

None microscope.controllers.zaber._ZaberLED.__init__	(		self,
		_ZaberDeviceConnection	dev_conn,
		int	channel )

Reimplemented from microscope.abc.LightSource.

Definition at line 427 of file zaber.py.

    def __init__(self, dev_conn: _ZaberDeviceConnection, channel: int) -> None:
        super().__init__()
        self._dev_conn = dev_conn
        self._channel = channel
        self._max_flux = self._dev_conn.get_lamp_max_flux(self._channel)
        self.add_setting(
            "temperature",
            "float",
            lambda: self._dev_conn.get_lamp_temperature(self._channel),
            None,
            values=tuple(),
        )
 
        for our_name, their_name in [
            ("wavelength peak", "lamp.wavelength.peak"),
            ("wavelength fwhm", "lamp.wavelength.fwhm"),
        ]:
            reply = self._dev_conn.command(
                b"get %s" % their_name.encode(), self._channel
            )
            value = float(reply.response)
            self.add_setting(
                our_name,
                "float",
                lambda x=value: x,
                None,
                values=tuple(),
            )
 

Member Function Documentation

_do_disable()

None microscope.controllers.zaber._ZaberLED._do_disable ( self )

protected

Do any device-specific work on disable.

Subclasses should override this method rather than modify
`disable`.

Reimplemented from microscope.abc.Device.

Definition at line 466 of file zaber.py.

    def _do_disable(self) -> None:
        self._dev_conn.lamp_off(self._channel)
 

_do_enable()

bool microscope.controllers.zaber._ZaberLED._do_enable ( self )

protected

Do any device specific work on enable.

Subclasses should override this method, rather than modify
`enable`.

Reimplemented from microscope.abc.Device.

Definition at line 462 of file zaber.py.

    def _do_enable(self) -> bool:
        self._dev_conn.lamp_on(self._channel)
        return True
 

_do_get_power()

float microscope.controllers.zaber._ZaberLED._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented from microscope.abc.LightSource.

Definition at line 469 of file zaber.py.

    def _do_get_power(self) -> float:
        return self._dev_conn.get_lamp_flux(self._channel) / self._max_flux
 

_do_set_power()

None microscope.controllers.zaber._ZaberLED._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 472 of file zaber.py.

    def _do_set_power(self, power: float) -> None:
        self._dev_conn.set_lamp_flux(self._channel, power * self._max_flux)
 

_do_shutdown()

None microscope.controllers.zaber._ZaberLED._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 456 of file zaber.py.

    def _do_shutdown(self) -> None:
        pass
 

get_is_on()

bool microscope.controllers.zaber._ZaberLED.get_is_on

(

self

)

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

Reimplemented from microscope.abc.LightSource.

Definition at line 475 of file zaber.py.

    def get_is_on(self) -> bool:
        return self._dev_conn.get_lamp_is_on(self._channel)
 
 

get_status()

typing.List[str] microscope.controllers.zaber._ZaberLED.get_status

(

self

)

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 459 of file zaber.py.

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

Member Data Documentation

_channel

microscope.controllers.zaber._ZaberLED._channel = channel

protected

Definition at line 430 of file zaber.py.

_dev_conn

microscope.controllers.zaber._ZaberLED._dev_conn = dev_conn

protected

Definition at line 429 of file zaber.py.

_max_flux

microscope.controllers.zaber._ZaberLED._max_flux = self._dev_conn.get_lamp_max_flux(self._channel)

protected

Definition at line 431 of file zaber.py.

---

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

• BioImager/PythonMicroscope/microscope/controllers/zaber.py