microscope.lights.toptica.TopticaiBeam Class Reference

Inheritance diagram for microscope.lights.toptica.TopticaiBeam:

Public Member Functions
None	__init__ (self, str port, **kwargs)
typing.List[str]	get_status (self)
None	enable (self)
None	disable (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
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.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.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

Toptica iBeam smart laser.

Control of laser power is performed by setting the power level on
the normal channel (#2) only.  The bias channel (#1) is left
unmodified and so defines the lowest level power.

Definition at line 205 of file toptica.py.

Constructor & Destructor Documentation

__init__()

None microscope.lights.toptica.TopticaiBeam.__init__	(		self,
		str	port,
		**	kwargs
	)

Reimplemented from microscope.abc.LightSource.

Definition at line 216 of file toptica.py.

    def __init__(self, port: str, **kwargs) -> None:
        super().__init__(**kwargs)
        self._conn = _iBeamConnection(port)
        # The Toptica iBeam has up to five operation modes, named
        # "channels" on the documentation.  Only the first three
        # channels have any sort of documentation:
        #
        #   Ch 1: bias level channel
        #   Ch 2: normal operating level channel
        #   Ch 3: only used at high-power models
        #
        # We haven't come across a laser with a channel 3 so we are
        # ignoring it until then.  So we just leave the bias channel
        # (1) alone and control power via the normal channel (2).
        self._max_power = self._conn.show_max_power()
 

Member Function Documentation

disable()

None microscope.lights.toptica.TopticaiBeam.disable

(

self

)

Disable the device for a short period for inactivity.

Reimplemented from microscope.abc.Device.

Definition at line 242 of file toptica.py.

    def disable(self) -> None:
        self._conn.laser_off()
 

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.abc.DataDevice.__init__(), microscope.lights.cobolt.CoboltLaser.get_status(), microscope.lights.deepstar.DeepstarLaser.get_status(), microscope.lights.obis.ObisLaser.get_status(), and microscope.abc.Device.shutdown().

enable()

None microscope.lights.toptica.TopticaiBeam.enable

(

self

)

Enable the device.

Reimplemented from microscope.abc.Device.

Definition at line 239 of file toptica.py.

    def enable(self) -> None:
        self._conn.laser_on()
 

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.

get_is_on()

bool microscope.lights.toptica.TopticaiBeam.get_is_on

(

self

)

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

Reimplemented from microscope.abc.LightSource.

Definition at line 245 of file toptica.py.

    def get_is_on(self) -> bool:
        state = self._conn.status_laser()
        if state == b"ON":
            return True
        elif state == b"OFF":
            return False
        else:
            raise microscope.DeviceError(
                "Unexpected laser status: %s" % state.decode()
            )
 

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, microscope.stages.ludl.ludlMC2000._conn, microscope.lights.toptica.TopticaiBeam._get_max_power_mw(), microscope.lights.cobolt.CoboltLaser._get_power_mw(), microscope.lights.obis.ObisLaser._get_power_mw(), microscope.lights.sapphire.SapphireLaser._get_power_mw(), microscope.lights.toptica.TopticaiBeam._get_power_mw(), microscope.lights.toptica.TopticaiBeam._max_power, microscope.lights.cobolt.CoboltLaser._set_power_mw(), microscope.lights.toptica.TopticaiBeam._set_power_mw(), microscope.lights.obis.ObisLaser._set_power_mw(), and microscope.lights.sapphire.SapphireLaser._set_power_mw().

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.lights.toptica.TopticaiBeam.get_status

(

self

)

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 235 of file toptica.py.

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

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

---

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

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