microscope.controllers.toptica._iChromeLaserConnection Class Reference

Public Member Functions
None	__init__ (self, _iChromeConnection conn, int laser_number)
str	get_label (self)
str	get_type (self)
int	get_delay (self)
bool	get_enable (self)
None	set_enable (self, bool state)
bool	get_cw (self)
None	set_cw (self, bool state)
bool	get_use_ttl (self)
None	set_use_ttl (self, bool state)
float	get_level (self)
None	set_level (self, float level)
str	get_status_txt (self)

Protected Member Functions
bytes	_param_ref (self, bytes name)
None	_param_set (self, bytes name, bytes value)

Protected Attributes
	_conn = conn
str	_param_prefix = b"laser%d:" % laser_number

Detailed Description

Definition at line 108 of file toptica.py.

Constructor & Destructor Documentation

__init__()

None microscope.controllers.toptica._iChromeLaserConnection.__init__	(		self,
		_iChromeConnection	conn,
		int	laser_number )

Definition at line 109 of file toptica.py.

    def __init__(self, conn: _iChromeConnection, laser_number: int) -> None:
        self._conn = conn
        self._param_prefix = b"laser%d:" % laser_number
 
        # We Need to confirm that indeed there is a laser at this
        # position.  There is no command to check this, we just try to
        # read a parameter and check if it works.
        try:
            self.get_label()
        except microscope.DeviceError as ex:
            raise microscope.DeviceError(
                "failed to get label, probably no laser %d" % laser_number
            ) from ex
 

Member Function Documentation

_param_ref()

bytes microscope.controllers.toptica._iChromeLaserConnection._param_ref ( self, bytes name )

protected

Definition at line 123 of file toptica.py.

    def _param_ref(self, name: bytes) -> bytes:
        return self._conn.param_ref(self._param_prefix + name)
 

_param_set()

None microscope.controllers.toptica._iChromeLaserConnection._param_set ( self, bytes name, bytes value )

protected

Definition at line 126 of file toptica.py.

    def _param_set(self, name: bytes, value: bytes) -> None:
        self._conn.param_set(self._param_prefix + name, value)
 

get_cw()

bool microscope.controllers.toptica._iChromeLaserConnection.get_cw

(

self

)

Definition at line 145 of file toptica.py.

    def get_cw(self) -> bool:
        return _parse_bool(self._param_ref(b"cw"))
 

get_delay()

int microscope.controllers.toptica._iChromeLaserConnection.get_delay

(

self

)

Definition at line 135 of file toptica.py.

    def get_delay(self) -> int:
        return int(self._param_ref(b"delay"))
 

get_enable()

bool microscope.controllers.toptica._iChromeLaserConnection.get_enable

(

self

)

Definition at line 138 of file toptica.py.

    def get_enable(self) -> bool:
        return _parse_bool(self._param_ref(b"enable"))
 

get_label()

str microscope.controllers.toptica._iChromeLaserConnection.get_label

(

self

)

Definition at line 129 of file toptica.py.

    def get_label(self) -> str:
        return _parse_string(self._param_ref(b"label"))
 

get_level()

float microscope.controllers.toptica._iChromeLaserConnection.get_level

(

self

)

Definition at line 159 of file toptica.py.

    def get_level(self) -> float:
        return float(self._param_ref(b"level"))
 

get_status_txt()

str microscope.controllers.toptica._iChromeLaserConnection.get_status_txt

(

self

)

Definition at line 166 of file toptica.py.

    def get_status_txt(self) -> str:
        return _parse_string(self._param_ref(b"status-txt"))
 
 

get_type()

str microscope.controllers.toptica._iChromeLaserConnection.get_type

(

self

)

Definition at line 132 of file toptica.py.

    def get_type(self) -> str:
        return _parse_string(self._param_ref(b"type"))
 

get_use_ttl()

bool microscope.controllers.toptica._iChromeLaserConnection.get_use_ttl

(

self

)

Definition at line 152 of file toptica.py.

    def get_use_ttl(self) -> bool:
        return _parse_bool(self._param_ref(b"use-ttl"))
 

set_cw()

None microscope.controllers.toptica._iChromeLaserConnection.set_cw	(		self,
		bool	state )

Definition at line 148 of file toptica.py.

    def set_cw(self, state: bool) -> None:
        value = b"#t" if state else b"#f"
        self._param_set(b"cw", value)
 

set_enable()

None microscope.controllers.toptica._iChromeLaserConnection.set_enable	(		self,
		bool	state )

Definition at line 141 of file toptica.py.

    def set_enable(self, state: bool) -> None:
        value = b"#t" if state else b"#f"
        self._param_set(b"enable", value)
 

set_level()

None microscope.controllers.toptica._iChromeLaserConnection.set_level	(		self,
		float	level )

Definition at line 162 of file toptica.py.

    def set_level(self, level: float) -> None:
        value = b"%.1f" % level
        self._param_set(b"level", value)
 

set_use_ttl()

None microscope.controllers.toptica._iChromeLaserConnection.set_use_ttl	(		self,
		bool	state )

Definition at line 155 of file toptica.py.

    def set_use_ttl(self, state: bool) -> None:
        value = b"#t" if state else b"#f"
        self._param_set(b"use-ttl", value)
 

Member Data Documentation

_conn

microscope.controllers.toptica._iChromeLaserConnection._conn = conn

protected

Definition at line 110 of file toptica.py.

_param_prefix

str microscope.controllers.toptica._iChromeLaserConnection._param_prefix = b"laser%d:" % laser_number

protected

Definition at line 111 of file toptica.py.

---

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

• BioImager/PythonMicroscope/microscope/controllers/toptica.py