microscope.simulators.SimulatedDeformableMirror Class Reference

Inheritance diagram for microscope.simulators.SimulatedDeformableMirror:

Public Member Functions
	__init__ (self, n_actuators, **kwargs)
int	n_actuators (self)
	get_current_pattern (self)
Public Member Functions inherited from microscope._utils.OnlyTriggersOnceOnSoftwareMixin
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
Public Member Functions inherited from microscope.abc.DeformableMirror
None	apply_pattern (self, numpy.ndarray pattern)
None	queue_patterns (self, numpy.ndarray patterns)
None	next_pattern (self)
None	trigger (self)
Public Member Functions inherited from microscope.abc.Device
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)
	get_setting (self, str name)
	get_all_settings (self)
None	set_setting (self, str name, value)
	describe_setting (self, str name)
	describe_settings (self)
	update_settings (self, incoming, bool init=False)

Protected Member Functions
None	_do_shutdown (self)
	_do_apply_pattern (self, pattern)
Protected Member Functions inherited from microscope.abc.TriggerTargetMixin
Protected Member Functions inherited from microscope.abc.DeformableMirror
None	_validate_patterns (self, numpy.ndarray patterns)
None	_do_trigger (self)
Protected Member Functions inherited from microscope.abc.Device
	_do_disable (self)
	_do_enable (self)

Protected Attributes
int	_n_actuators = n_actuators
	_current_pattern = pattern
Protected Attributes inherited from microscope.abc.DeformableMirror
typing.Optional[numpy.ndarray]	_patterns = None
int	_pattern_idx = -1
Protected Attributes inherited from microscope.abc.Device
dict	_settings = {}

Additional Inherited Members
Public Attributes inherited from microscope.abc.DeformableMirror
Public Attributes inherited from microscope.abc.Device
bool	enabled = False

Detailed Description

Definition at line 376 of file __init__.py.

Constructor & Destructor Documentation

__init__()

microscope.simulators.SimulatedDeformableMirror.__init__	(		self,
			n_actuators,
		**	kwargs )

Reimplemented from microscope.abc.DeformableMirror.

Definition at line 380 of file __init__.py.

    def __init__(self, n_actuators, **kwargs):
        super().__init__(**kwargs)
        self._n_actuators = n_actuators
 

Member Function Documentation

_do_apply_pattern()

microscope.simulators.SimulatedDeformableMirror._do_apply_pattern ( self, pattern )

protected

Reimplemented from microscope.abc.DeformableMirror.

Definition at line 391 of file __init__.py.

    def _do_apply_pattern(self, pattern):
        self._current_pattern = pattern
 

_do_shutdown()

None microscope.simulators.SimulatedDeformableMirror._do_shutdown ( self )

protected

Private method - actual shutdown of the device.

Users should be calling :meth:`shutdown` and not this method.
Concrete implementations should implement this method instead
of `shutdown`.

Reimplemented from microscope.abc.Device.

Definition at line 384 of file __init__.py.

    def _do_shutdown(self) -> None:
        pass
 

get_current_pattern()

microscope.simulators.SimulatedDeformableMirror.get_current_pattern

(

self

)

Method for debug purposes only.

This method is not part of the DeformableMirror ABC, it only
exists on this test device to help during development.

Definition at line 394 of file __init__.py.

    def get_current_pattern(self):
        """Method for debug purposes only.
 
        This method is not part of the DeformableMirror ABC, it only
        exists on this test device to help during development.
        """
        return self._current_pattern
 
 

n_actuators()

int microscope.simulators.SimulatedDeformableMirror.n_actuators

(

self

)

Reimplemented from microscope.abc.DeformableMirror.

Definition at line 388 of file __init__.py.

    def n_actuators(self) -> int:
        return self._n_actuators
 

Member Data Documentation

_current_pattern

microscope.simulators.SimulatedDeformableMirror._current_pattern = pattern

protected

Definition at line 392 of file __init__.py.

_n_actuators

int microscope.simulators.SimulatedDeformableMirror._n_actuators = n_actuators

protected

Definition at line 382 of file __init__.py.

---

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

• BioImager/PythonMicroscope/microscope/simulators/__init__.py