microscope.controllers.coolled._CoolLEDChannel Class Reference

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

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

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

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

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, and microscope.controllers.coolled._CoolLEDChannel._should_be_on.

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"
 

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, and microscope.controllers.coolled._CoolLEDChannel._should_be_on.

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.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 []
 

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

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, and microscope.controllers.coolled._CoolLEDChannel._should_be_on.

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

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
 

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

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
 

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/coolled.py