Inheritance diagram for microscope.abc.TriggerTargetMixin:

Public Member Functions
microscope.TriggerMode	trigger_mode (self)

microscope.TriggerType	trigger_type (self)

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

None	trigger (self)

Protected Member Functions
None	_do_trigger (self)

Detailed Description

Mixin for a device that may be the target of a hardware trigger.

.. todo::

    Need some way to retrieve the supported trigger types and
    modes.  This is not just two lists, one for types and another
    for modes, because some modes can only be used with certain
    types and vice-versa.

Definition at line 224 of file abc.py.

Member Function Documentation

◆ _do_trigger()

None microscope.abc.TriggerTargetMixin._do_trigger ( self )

protected

Actual trigger of the device.

Classes implementing this interface should implement this
method instead of `trigger`.

Reimplemented in microscope._utils.OnlyTriggersBulbOnSoftwareMixin, microscope.abc.DeformableMirror, microscope.cameras.andorsdk3.AndorSDK3, microscope.cameras.atmcd.AndorAtmcd, microscope.cameras.picam.PiCamera, microscope.cameras.pvcam.PVCamera, microscope.cameras.ximea.XimeaCamera, microscope.controllers.coolled._CoolLEDChannel, microscope.controllers.toptica._iChromeLaser, microscope.lights.deepstar.DeepstarLaser, microscope.lights.obis.ObisLaser, and microscope.simulators.SimulatedCamera.

Definition at line 254 of file abc.py.

    def _do_trigger(self) -> None:
        """Actual trigger of the device.
 
        Classes implementing this interface should implement this
        method instead of `trigger`.
 
        """
        raise NotImplementedError()
 

◆ set_trigger()

None microscope.abc.TriggerTargetMixin.set_trigger	(		self,
		microscope.TriggerType	ttype,
		microscope.TriggerMode	tmode )

Set device for a specific trigger.

Reimplemented in microscope._utils.OnlyTriggersBulbOnSoftwareMixin, microscope._utils.OnlyTriggersOnceOnSoftwareMixin, microscope.cameras.andorsdk3.AndorSDK3, microscope.cameras.atmcd.AndorAtmcd, microscope.cameras.picam.PiCamera, microscope.cameras.pvcam.PVCamera, microscope.cameras.ximea.XimeaCamera, microscope.controllers.coolled._CoolLEDChannel, microscope.controllers.toptica._iChromeLaser, microscope.lights.deepstar.DeepstarLaser, microscope.lights.obis.ObisLaser, and microscope.mirror.alpao.AlpaoDeformableMirror.

Definition at line 247 of file abc.py.

    ) -> None:
        """Set device for a specific trigger."""
        raise NotImplementedError()
 

◆ trigger()

None microscope.abc.TriggerTargetMixin.trigger ( self )

Trigger device.

The actual effect is device type dependent.  For example, on a
`Camera` it triggers image acquisition while on a
`DeformableMirror` it applies a queued pattern.  See
documentation for the devices implementing this interface for
details.

Raises:
    microscope.IncompatibleStateError: if trigger type is not
        set to `TriggerType.SOFTWARE`.

Reimplemented in microscope.abc.DeformableMirror.

Definition at line 263 of file abc.py.

    def trigger(self) -> None:
        """Trigger device.
 
        The actual effect is device type dependent.  For example, on a
        `Camera` it triggers image acquisition while on a
        `DeformableMirror` it applies a queued pattern.  See
        documentation for the devices implementing this interface for
        details.
 
        Raises:
            microscope.IncompatibleStateError: if trigger type is not
                set to `TriggerType.SOFTWARE`.
 
        """
        if self.trigger_type is not microscope.TriggerType.SOFTWARE:
            raise microscope.IncompatibleStateError(
                "trigger type is not software"
            )
        _logger.debug("trigger by software")
        self._do_trigger()
 
 

◆ trigger_mode()

microscope.TriggerMode microscope.abc.TriggerTargetMixin.trigger_mode ( self )

Definition at line 238 of file abc.py.

    def trigger_mode(self) -> microscope.TriggerMode:
        raise NotImplementedError()
 

◆ trigger_type()

microscope.TriggerType microscope.abc.TriggerTargetMixin.trigger_type ( self )

Definition at line 243 of file abc.py.

    def trigger_type(self) -> microscope.TriggerType:
        raise NotImplementedError()
 

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

BioImager/PythonMicroscope/microscope/abc.py

Public Member Functions