microscope.simulators.SimulatedLightSource Class Reference

Inheritance diagram for microscope.simulators.SimulatedLightSource:

Public Member Functions
	__init__ (self, **kwargs)
	get_status (self)
	get_is_on (self)
Public Member Functions inherited from microscope._utils.OnlyTriggersBulbOnSoftwareMixin
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)
Public Member Functions inherited from microscope.abc.LightSource
float	power (self)
None	power (self, float power)
float	get_set_power (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
	_do_enable (self)
None	_do_shutdown (self)
	_do_disable (self)
None	_do_set_power (self, float power)
float	_do_get_power (self)
Protected Member Functions inherited from microscope._utils.OnlyTriggersBulbOnSoftwareMixin
None	_do_trigger (self)
Protected Member Functions inherited from microscope.abc.TriggerTargetMixin
Protected Member Functions inherited from microscope.abc.LightSource
Protected Member Functions inherited from microscope.abc.Device

Protected Attributes
float	_power = 0.0
bool	_emission = False
	_set_point
Protected Attributes inherited from microscope.abc.LightSource
float	_set_point = 0.0
Protected Attributes inherited from microscope.abc.Device
dict	_settings = {}

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

Detailed Description

Definition at line 339 of file __init__.py.

Constructor & Destructor Documentation

__init__()

microscope.simulators.SimulatedLightSource.__init__	(		self,
		**	kwargs )

Reimplemented from microscope.abc.LightSource.

Definition at line 343 of file __init__.py.

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self._power = 0.0
        self._emission = False
 

Member Function Documentation

_do_disable()

microscope.simulators.SimulatedLightSource._do_disable ( self )

protected

Do any device-specific work on disable.

Subclasses should override this method rather than modify
`disable`.

Reimplemented from microscope.abc.Device.

Definition at line 358 of file __init__.py.

    def _do_disable(self):
        self._emission = False
        return self._emission
 

_do_enable()

microscope.simulators.SimulatedLightSource._do_enable ( self )

protected

Do any device specific work on enable.

Subclasses should override this method, rather than modify
`enable`.

Reimplemented from microscope.abc.Device.

Definition at line 351 of file __init__.py.

    def _do_enable(self):
        self._emission = True
        return self._emission
 

_do_get_power()

float microscope.simulators.SimulatedLightSource._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented from microscope.abc.LightSource.

Definition at line 369 of file __init__.py.

    def _do_get_power(self) -> float:
        if self._emission:
            return self._power
        else:
            return 0.0
 
 

_do_set_power()

None microscope.simulators.SimulatedLightSource._do_set_power ( self, float power )

protected

Internal function that actually sets the light source power.

This function will be called by the `power` attribute setter
after clipping the argument to the [0, 1] interval.

Reimplemented from microscope.abc.LightSource.

Definition at line 365 of file __init__.py.

    def _do_set_power(self, power: float) -> None:
        _logger.info("Power set to %s.", power)
        self._power = power
 

_do_shutdown()

None microscope.simulators.SimulatedLightSource._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 355 of file __init__.py.

    def _do_shutdown(self) -> None:
        pass
 

get_is_on()

microscope.simulators.SimulatedLightSource.get_is_on

(

self

)

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

Reimplemented from microscope.abc.LightSource.

Definition at line 362 of file __init__.py.

    def get_is_on(self):
        return self._emission
 

get_status()

microscope.simulators.SimulatedLightSource.get_status

(

self

)

Query and return the light source status.

Reimplemented from microscope.abc.LightSource.

Definition at line 348 of file __init__.py.

    def get_status(self):
        return [str(x) for x in (self._emission, self._power, self._set_point)]
 

Member Data Documentation

_emission

bool microscope.simulators.SimulatedLightSource._emission = False

protected

Definition at line 346 of file __init__.py.

_power

microscope.simulators.SimulatedLightSource._power = 0.0

protected

Definition at line 345 of file __init__.py.

_set_point

microscope.simulators.SimulatedLightSource._set_point

protected

Definition at line 349 of file __init__.py.

---

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

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