microscope.controllers.toptica._iChromeLaser Class Reference

Inheritance diagram for microscope.controllers.toptica._iChromeLaser:

Public Member Functions
None	__init__ (self, _iChromeConnection conn, int laser_number)
typing.List[str]	get_status (self)
bool	get_is_on (self)
microscope.TriggerMode	trigger_mode (self)
microscope.TriggerType	trigger_type (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	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
float	_do_get_power (self)
None	_do_set_power (self, float power)
None	_do_enable (self)
None	_do_disable (self)
None	_do_shutdown (self)
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

Protected Attributes
	_conn = _iChromeLaserConnection(conn, laser_number)
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

Definition at line 170 of file toptica.py.

Constructor & Destructor Documentation

__init__()

None microscope.controllers.toptica._iChromeLaser.__init__	(		self,
		_iChromeConnection	conn,
		int	laser_number )

Reimplemented from microscope.abc.LightSource.

Definition at line 171 of file toptica.py.

    def __init__(self, conn: _iChromeConnection, laser_number: int) -> None:
        super().__init__()
        self._conn = _iChromeLaserConnection(conn, laser_number)
 
        # FIXME: set values to '0' because we need to pass an int as
        # values for settings of type str.  Probably a bug on
        # Device.set_setting.
        self.add_setting("label", "str", self._conn.get_label, None, values=0)
        self.add_setting("type", "str", self._conn.get_type, None, values=0)
 
        self.add_setting(
            "delay", "int", self._conn.get_delay, None, values=tuple()
        )
 

Member Function Documentation

_do_disable()

None microscope.controllers.toptica._iChromeLaser._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 209 of file toptica.py.

    def _do_disable(self) -> None:
        self._conn.set_enable(False)
 

_do_enable()

None microscope.controllers.toptica._iChromeLaser._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 206 of file toptica.py.

    def _do_enable(self) -> None:
        self._conn.set_enable(True)
 

_do_get_power()

float microscope.controllers.toptica._iChromeLaser._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented from microscope.abc.LightSource.

Definition at line 200 of file toptica.py.

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

_do_set_power()

None microscope.controllers.toptica._iChromeLaser._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 203 of file toptica.py.

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

_do_shutdown()

None microscope.controllers.toptica._iChromeLaser._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 212 of file toptica.py.

    def _do_shutdown(self) -> None:
        pass  # Nothing to do
 

_do_trigger()

None microscope.controllers.toptica._iChromeLaser._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 247 of file toptica.py.

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

get_is_on()

bool microscope.controllers.toptica._iChromeLaser.get_is_on

(

self

)

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

Reimplemented from microscope.abc.LightSource.

Definition at line 188 of file toptica.py.

    def get_is_on(self) -> bool:
        if self._conn.get_enable():
            if self._conn.get_cw():
                return True
            else:
                # There doesn't seem to be command to check whether
                # the TTL line is currently high, so just return True
                # if set that way.
                return self._conn.get_use_ttl()
        else:
            return False
 

get_status()

typing.List[str] microscope.controllers.toptica._iChromeLaser.get_status

(

self

)

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 185 of file toptica.py.

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

set_trigger()

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

Set device for a specific trigger.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 226 of file toptica.py.

    ) -> None:
        if tmode is not microscope.TriggerMode.BULB:
            raise microscope.UnsupportedFeatureError(
                "only TriggerMode.BULB mode is supported"
            )
 
        # From the manual it seems that cw and ttl parameters are
        # mutually exclusive but also still need to be set separately.
        if ttype is microscope.TriggerType.HIGH:
            self._conn.set_cw(False)
            self._conn.set_use_ttl(True)
        elif ttype is microscope.TriggerType.SOFTWARE:
            self._conn.set_use_ttl(False)
            self._conn.set_cw(True)
        else:
            raise microscope.UnsupportedFeatureError(
                "only trigger type HIGH and SOFTWARE are supported"
            )
 

trigger_mode()

microscope.TriggerMode microscope.controllers.toptica._iChromeLaser.trigger_mode

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 216 of file toptica.py.

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

trigger_type()

microscope.TriggerType microscope.controllers.toptica._iChromeLaser.trigger_type

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 220 of file toptica.py.

    def trigger_type(self) -> microscope.TriggerType:
        if self._conn.get_use_ttl():
            return microscope.TriggerType.HIGH
        else:
            return microscope.TriggerType.SOFTWARE
 

Member Data Documentation

_conn

microscope.controllers.toptica._iChromeLaser._conn = _iChromeLaserConnection(conn, laser_number)

protected

Definition at line 173 of file toptica.py.

---

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

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