microscope._utils.OnlyTriggersBulbOnSoftwareMixin Class Reference

Inheritance diagram for microscope._utils.OnlyTriggersBulbOnSoftwareMixin:

Public Member Functions
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
None	trigger (self)

Protected Member Functions
None	_do_trigger (self)
Protected Member Functions inherited from microscope.abc.TriggerTargetMixin

Detailed Description

Utility mixin for devices that only trigger "bulb" with software.

This mixin avoids code duplication for the many devices whose only
supported trigger type and trigger mode are `TriggerType.SOFTWARE`
and `TriggerMode.BULB`.

Definition at line 76 of file _utils.py.

Member Function Documentation

_do_trigger()

None microscope._utils.OnlyTriggersBulbOnSoftwareMixin._do_trigger ( self )

protected

Actual trigger of the device.

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

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 105 of file _utils.py.

    def _do_trigger(self) -> None:
        raise microscope.IncompatibleStateError(
            "trigger does not make sense in trigger mode bulb, only enable"
        )
 
 

set_trigger()

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

Set device for a specific trigger.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 93 of file _utils.py.

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

trigger_mode()

microscope.TriggerMode microscope._utils.OnlyTriggersBulbOnSoftwareMixin.trigger_mode

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 90 of file _utils.py.

    def trigger_mode(self) -> microscope.TriggerMode:
        return microscope.TriggerMode.BULB
 

trigger_type()

microscope.TriggerType microscope._utils.OnlyTriggersBulbOnSoftwareMixin.trigger_type

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 86 of file _utils.py.

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

---

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

• BioImager/PythonMicroscope/microscope/_utils.py