microscope._utils.OnlyTriggersOnceOnSoftwareMixin Class Reference

Inheritance diagram for microscope._utils.OnlyTriggersOnceOnSoftwareMixin:

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
microscope.TriggerMode	trigger_mode (self)
microscope.TriggerType	trigger_type (self)
None	set_trigger (self, microscope.TriggerType ttype, microscope.TriggerMode tmode)
None	trigger (self)

Detailed Description

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

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

Definition at line 46 of file _utils.py.

Member Function Documentation

set_trigger()

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

Set device for a specific trigger.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 63 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.ONCE:
            raise microscope.UnsupportedFeatureError(
                "the only trigger mode supported is 'once'"
            )
 
 

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

trigger_mode()

microscope.TriggerMode microscope._utils.OnlyTriggersOnceOnSoftwareMixin.trigger_mode

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 60 of file _utils.py.

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

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

trigger_type()

microscope.TriggerType microscope._utils.OnlyTriggersOnceOnSoftwareMixin.trigger_type

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 56 of file _utils.py.

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

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