microscope.abc.LightSource Class Reference

Inheritance diagram for microscope.abc.LightSource:

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

Protected Attributes
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

Light source such as lasers or LEDs.

Light sources often, possibly always, only support the
`TriggerMode.BULB`.  In this context, the trigger type changes
what happens when `enable` is called.  `TriggerType.SOFTWARE`
means that `enable` will make the device emit light immediately,
and disable will make the device stop emit light.

`TriggerType.HIGH` or `TriggerType.LOW` means that `enable` will
set and unset the laser such that it only emits light while
receiving a high or low TTL, or digital, input signal.

Definition at line 1185 of file abc.py.

Constructor & Destructor Documentation

__init__()

microscope.abc.LightSource.__init__	(		self,
		**	kwargs )

Reimplemented from microscope.abc.Device.

Definition at line 1201 of file abc.py.

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self._set_point = 0.0
 

Member Function Documentation

_do_get_power()

float microscope.abc.LightSource._do_get_power ( self )

protected

Internal function that actually returns the light source power.

Reimplemented in microscope.controllers.coolled._CoolLEDChannel, microscope.controllers.lumencor._SpectraIIILightChannel, microscope.controllers.toptica._iChromeLaser, microscope.controllers.zaber._ZaberLED, microscope.lights.cobolt.CoboltLaser, microscope.lights.deepstar.DeepstarLaser, microscope.lights.obis.ObisLaser, microscope.lights.sapphire.SapphireLaser, microscope.lights.toptica.TopticaiBeam, and microscope.simulators.SimulatedLightSource.

Definition at line 1217 of file abc.py.

    def _do_get_power(self) -> float:
        """Internal function that actually returns the light source power."""
        raise NotImplementedError()
 

_do_set_power()

None microscope.abc.LightSource._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 in microscope.controllers.coolled._CoolLEDChannel, microscope.controllers.lumencor._SpectraIIILightChannel, microscope.controllers.toptica._iChromeLaser, microscope.controllers.zaber._ZaberLED, microscope.lights.cobolt.CoboltLaser, microscope.lights.deepstar.DeepstarLaser, microscope.lights.obis.ObisLaser, microscope.lights.sapphire.SapphireLaser, microscope.lights.toptica.TopticaiBeam, and microscope.simulators.SimulatedLightSource.

Definition at line 1222 of file abc.py.

    def _do_set_power(self, power: float) -> None:
        """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.
 
        """
        raise NotImplementedError()
 

get_is_on()

bool microscope.abc.LightSource.get_is_on

(

self

)

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

Reimplemented in microscope.controllers.coolled._CoolLEDChannel, microscope.controllers.lumencor._SpectraIIILightChannel, microscope.controllers.toptica._iChromeLaser, microscope.controllers.zaber._ZaberLED, microscope.lights.cobolt.CoboltLaser, microscope.lights.deepstar.DeepstarLaser, microscope.lights.obis.ObisLaser, microscope.lights.sapphire.SapphireLaser, microscope.lights.toptica.TopticaiBeam, and microscope.simulators.SimulatedLightSource.

Definition at line 1212 of file abc.py.

    def get_is_on(self) -> bool:
        """Return True if the light source is currently able to produce light."""
        pass
 

get_set_power()

float microscope.abc.LightSource.get_set_power

(

self

)

Return the power set point.

Definition at line 1246 of file abc.py.

    def get_set_power(self) -> float:
        """Return the power set point."""
        return self._set_point
 
 

get_status()

typing.List[str] microscope.abc.LightSource.get_status

(

self

)

Query and return the light source status.

Reimplemented in microscope.controllers.coolled._CoolLEDChannel, microscope.controllers.lumencor._SpectraIIILightChannel, microscope.controllers.toptica._iChromeLaser, microscope.controllers.zaber._ZaberLED, microscope.lights.cobolt.CoboltLaser, microscope.lights.deepstar.DeepstarLaser, microscope.lights.obis.ObisLaser, microscope.lights.sapphire.SapphireLaser, microscope.lights.toptica.TopticaiBeam, and microscope.simulators.SimulatedLightSource.

Definition at line 1206 of file abc.py.

    def get_status(self) -> typing.List[str]:
        """Query and return the light source status."""
        result = []
        return result
 

power() [1/2]

float microscope.abc.LightSource.power

(

self

)

Light source power in the [0, 1] interval.

Definition at line 1232 of file abc.py.

    def power(self) -> float:
        """Light source power in the [0, 1] interval."""
        return self._do_get_power()
 

power() [2/2]

None microscope.abc.LightSource.power	(		self,
		float	power )

Light source power in the [0, 1] interval.

The power value will be clipped to [0, 1] interval.

Definition at line 1237 of file abc.py.

    def power(self, power: float) -> None:
        """Light source power in the [0, 1] interval.
 
        The power value will be clipped to [0, 1] interval.
        """
        clipped_power = max(min(power, 1.0), 0.0)
        self._do_set_power(clipped_power)
        self._set_point = clipped_power
 

Member Data Documentation

_set_point

float microscope.abc.LightSource._set_point = 0.0

protected

Definition at line 1203 of file abc.py.

---

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

• BioImager/PythonMicroscope/microscope/abc.py