microscope.lights.deepstar.DeepstarLaser Class Reference

Inheritance diagram for microscope.lights.deepstar.DeepstarLaser:

Public Member Functions
def	__init__ (self, com, baud=9600, timeout=2.0, **kwargs)
def	get_status (self)
def	get_is_on (self)
microscope.TriggerType	trigger_type (self)
microscope.TriggerMode	trigger_mode (self)
None	set_trigger (self, microscope.TriggerType ttype, microscope.TriggerMode tmode)
def	__init__ (self, **kwargs)
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)

Public Attributes
	connection
Public Attributes inherited from microscope.abc.SerialDeviceMixin
	connection
Public Attributes inherited from microscope.abc.Device
	enabled

Additional Inherited Members
Static Public Member Functions inherited from microscope.abc.SerialDeviceMixin
def	lock_comms (func)

Detailed Description

Omicron DeepStar laser.

Omicron LDM lasers can be bought with and without the LDM.APC
power monitoring option (light pick-off).  If this option is not
available, the `power` attribute will return the set power value
instead of the actual power value.

Definition at line 32 of file deepstar.py.

Constructor & Destructor Documentation

__init__()

def microscope.lights.deepstar.DeepstarLaser.__init__	(		self,
			com,
			baud = 9600,
			timeout = 2.0,
		**	kwargs
	)

Reimplemented from microscope.abc.SerialDeviceMixin.

Definition at line 44 of file deepstar.py.

    def __init__(self, com, baud=9600, timeout=2.0, **kwargs):
        super().__init__(**kwargs)
        self.connection = serial.Serial(
            port=com,
            baudrate=baud,
            timeout=timeout,
            stopbits=serial.STOPBITS_ONE,
            bytesize=serial.EIGHTBITS,
            parity=serial.PARITY_NONE,
        )
        # If the laser is currently on, then we need to use 7-byte mode; otherwise we need to
        # use 16-byte mode.
        self._write(b"S?")
        response = self._readline()
        _logger.info("Current laser state: [%s]", response.decode())
 
        self._write(b"STAT3")
        option_codes = self._readline()
        if not option_codes.startswith(b"OC "):
            raise microscope.DeviceError(
                "Failed to get option codes '%s'" % option_codes.decode()
            )
        if option_codes[9:12] == b"AP1":
            self._has_apc = True
        else:
            _logger.warning(
                "Laser is missing APC option.  Will return set"
                " power instead of actual power"
            )
            self._has_apc = False
 

Member Function Documentation

get_is_on()

def microscope.lights.deepstar.DeepstarLaser.get_is_on

(

self

)

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

Reimplemented from microscope.abc.LightSource.

Definition at line 136 of file deepstar.py.

    def get_is_on(self):
        self._write(b"S?")
        response = self._readline()
        _logger.debug("Are we on? [%s]", response.decode())
        return response == b"S2"
 

References microscope.lights.deepstar.DeepstarLaser._has_apc, microscope.abc.SerialDeviceMixin._readline(), microscope.filterwheels.thorlabs.ThorlabsFilterWheel._readline(), microscope.lights.obis.ObisLaser._readline(), microscope.abc.SerialDeviceMixin._write(), microscope.lights.deepstar.DeepstarLaser._write(), microscope.lights.obis.ObisLaser._write(), microscope.lights.sapphire.SapphireLaser._write(), microscope.abc.LightSource.get_is_on(), microscope.controllers.coolled._CoolLEDChannel.get_is_on(), microscope.controllers.lumencor._SpectraIIILightChannel.get_is_on(), microscope.controllers.toptica._iChromeLaser.get_is_on(), microscope.controllers.zaber._ZaberLED.get_is_on(), microscope.lights.cobolt.CoboltLaser.get_is_on(), microscope.lights.deepstar.DeepstarLaser.get_is_on(), microscope.lights.obis.ObisLaser.get_is_on(), microscope.lights.sapphire.SapphireLaser.get_is_on(), microscope.lights.toptica.TopticaiBeam.get_is_on(), and microscope.simulators.SimulatedLightSource.get_is_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()

def microscope.lights.deepstar.DeepstarLaser.get_status

(

self

)

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 87 of file deepstar.py.

    def get_status(self):
        result = []
        for i in range(4):
            self._write(("STAT%d" % i).encode())
            result.append(self._readline().decode())
        return result
 

References microscope.abc.SerialDeviceMixin._readline(), microscope.filterwheels.thorlabs.ThorlabsFilterWheel._readline(), microscope.lights.obis.ObisLaser._readline(), microscope.abc.SerialDeviceMixin._write(), microscope.lights.deepstar.DeepstarLaser._write(), microscope.lights.obis.ObisLaser._write(), microscope.lights.sapphire.SapphireLaser._write(), microscope.abc.Device.disable(), microscope.abc.DataDevice.disable(), microscope.controllers.coolled._CoolLEDChannel.disable(), microscope.controllers.lumencor._SpectraIIILightChannel.disable(), microscope.lights.cobolt.CoboltLaser.disable(), microscope.lights.sapphire.SapphireLaser.disable(), microscope.lights.toptica.TopticaiBeam.disable(), microscope.abc.LightSource.get_is_on(), microscope.controllers.coolled._CoolLEDChannel.get_is_on(), microscope.controllers.lumencor._SpectraIIILightChannel.get_is_on(), microscope.controllers.toptica._iChromeLaser.get_is_on(), microscope.controllers.zaber._ZaberLED.get_is_on(), microscope.lights.cobolt.CoboltLaser.get_is_on(), microscope.lights.deepstar.DeepstarLaser.get_is_on(), microscope.lights.obis.ObisLaser.get_is_on(), microscope.lights.sapphire.SapphireLaser.get_is_on(), microscope.lights.toptica.TopticaiBeam.get_is_on(), and microscope.simulators.SimulatedLightSource.get_is_on().

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.lights.deepstar.DeepstarLaser.set_trigger	(		self,
		microscope.TriggerType	ttype,
		microscope.TriggerMode	tmode
	)

Set device for a specific trigger.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 181 of file deepstar.py.

    ) -> None:
        if ttype is not microscope.TriggerType.HIGH:
            raise microscope.UnsupportedFeatureError(
                "the only trigger type supported is 'high'"
            )
        if tmode is not microscope.TriggerMode.BULB:
            raise microscope.UnsupportedFeatureError(
                "the only trigger mode supported is 'bulb'"
            )
 

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

trigger_mode()

microscope.TriggerMode microscope.lights.deepstar.DeepstarLaser.trigger_mode

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 178 of file deepstar.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.lights.deepstar.DeepstarLaser.trigger_type

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 174 of file deepstar.py.

    def trigger_type(self) -> microscope.TriggerType:
        return microscope.TriggerType.HIGH
 

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

Member Data Documentation

connection

microscope.lights.deepstar.DeepstarLaser.connection

Definition at line 46 of file deepstar.py.

Referenced by microscope.filterwheels.thorlabs.ThorlabsFilterWheel.__init__(), microscope.lights.cobolt.CoboltLaser.get_status(), microscope.lights.cobolt.CoboltLaser.initialize(), microscope.lights.sapphire.SapphireLaser.initialize(), and microscope.abc.SerialDeviceMixin.lock_comms().

---

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

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