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
def	__init__ (self, **kwargs)
typing.List[str]	get_status (self)
bool	get_is_on (self)
float	power (self)
None	power (self, float power)
float	get_set_power (self)
Public Member Functions inherited from microscope.abc.TriggerTargetMixin
microscope.TriggerMode	trigger_mode (self)
microscope.TriggerType	trigger_type (self)
None	set_trigger (self, microscope.TriggerType ttype, microscope.TriggerMode tmode)
None	trigger (self)
Public Member Functions inherited from microscope.abc.Device
None	__init__ (self)
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)
def	get_setting (self, str name)
def	get_all_settings (self)
None	set_setting (self, str name, value)
def	describe_setting (self, str name)
def	describe_settings (self)
def	update_settings (self, incoming, bool init=False)

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

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

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
 

References microscope.controllers.coolled._CoolLEDChannelConnection._conn, microscope.controllers.coolled._CoolLEDChannel._conn, microscope.controllers.lumencor._LightChannelConnection._conn, microscope.controllers.lumencor._SpectraIIILightChannel._conn, microscope.controllers.prior.ProScanIII._conn, microscope.controllers.prior._ProScanIIIFilterWheel._conn, microscope.controllers.toptica._iChromeLaserConnection._conn, microscope.controllers.toptica._iChromeLaser._conn, microscope.controllers.zaber._ZaberDeviceConnection._conn, microscope.controllers.zaber.ZaberDaisyChain._conn, microscope.lights.toptica.TopticaiBeam._conn, and microscope.stages.ludl.ludlMC2000._conn.

Referenced by microscope.lights.cobolt.CoboltLaser.get_is_on(), microscope.lights.deepstar.DeepstarLaser.get_is_on(), microscope.lights.obis.ObisLaser.get_is_on(), microscope.lights.deepstar.DeepstarLaser.get_status(), microscope.lights.obis.ObisLaser.get_status(), microscope.lights.cobolt.CoboltLaser.initialize(), microscope.lights.obis.ObisLaser.initialize(), and microscope.lights.sapphire.SapphireLaser.initialize().

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()
 

References microscope.controllers.coolled._CoolLEDChannelConnection._conn, microscope.controllers.coolled._CoolLEDChannel._conn, microscope.controllers.lumencor._LightChannelConnection._conn, microscope.controllers.lumencor._SpectraIIILightChannel._conn, microscope.controllers.prior.ProScanIII._conn, microscope.controllers.prior._ProScanIIIFilterWheel._conn, microscope.controllers.toptica._iChromeLaserConnection._conn, microscope.controllers.toptica._iChromeLaser._conn, microscope.controllers.zaber._ZaberDeviceConnection._conn, microscope.controllers.zaber.ZaberDaisyChain._conn, microscope.lights.toptica.TopticaiBeam._conn, and microscope.stages.ludl.ludlMC2000._conn.

Referenced by microscope.lights.obis.ObisLaser.get_status(), microscope.lights.cobolt.CoboltLaser.initialize(), microscope.lights.obis.ObisLaser.initialize(), microscope.lights.sapphire.SapphireLaser.initialize(), microscope.lights.cobolt.CoboltLaser.send(), and microscope.lights.sapphire.SapphireLaser.send().

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"
            )
 

References microscope.controllers.coolled._CoolLEDChannelConnection._conn, microscope.controllers.coolled._CoolLEDChannel._conn, microscope.controllers.lumencor._LightChannelConnection._conn, microscope.controllers.lumencor._SpectraIIILightChannel._conn, microscope.controllers.prior.ProScanIII._conn, microscope.controllers.prior._ProScanIIIFilterWheel._conn, microscope.controllers.toptica._iChromeLaserConnection._conn, microscope.controllers.toptica._iChromeLaser._conn, microscope.controllers.zaber._ZaberDeviceConnection._conn, microscope.controllers.zaber.ZaberDaisyChain._conn, microscope.lights.toptica.TopticaiBeam._conn, and microscope.stages.ludl.ludlMC2000._conn.

Referenced by microscope.cameras.picam.PiCamera.__init__(), microscope.cameras.ximea.XimeaCamera.__init__(), and microscope.cameras.ximea.XimeaCamera.initialize().

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
 

Referenced by microscope.cameras.picam.PiCamera.__init__(), and microscope.cameras.ximea.XimeaCamera.__init__().

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
 

Referenced by microscope.cameras.ximea.XimeaCamera.__init__(), microscope.abc.DeformableMirror.apply_pattern(), and microscope.abc.TriggerTargetMixin.trigger().

---

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

• F:/repos/BioImager/BioImager/PythonMicroscope/microscope/controllers/toptica.py