microscope.cameras.ximea.XimeaCamera Class Reference

Inheritance diagram for microscope.cameras.ximea.XimeaCamera:

Public Member Functions
None	__init__ (self, typing.Optional[str] serial_number=None, **kwargs)
def	abort (self)
None	initialize (self)
None	set_exposure_time (self, float value)
float	get_exposure_time (self)
def	get_cycle_time (self)
None	soft_trigger (self)
microscope.TriggerMode	trigger_mode (self)
microscope.TriggerType	trigger_type (self)
None	set_trigger (self, microscope.TriggerType ttype, microscope.TriggerMode tmode)
Public Member Functions inherited from microscope.abc.Camera
None	__init__ (self, **kwargs)
def	set_readout_mode (self, description)
def	get_transform (self)
def	set_transform (self, transform)
None	set_exposure_time (self, float value)
float	get_exposure_time (self)
float	get_cycle_time (self)
typing.Tuple[int, int]	get_sensor_shape (self)
microscope.Binning	get_binning (self)
None	set_binning (self, microscope.Binning binning)
microscope.ROI	get_roi (self)
None	set_roi (self, microscope.ROI roi)
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.DataDevice
None	__init__ (self, int buffer_length=0, **kwargs)
def	__del__ (self)
None	abort (self)
None	enable (self)
None	disable (self)
None	set_client (self, new_client)
None	update_settings (self, settings, bool init=False)
None	receiveClient (self, str client_uri)
def	grab_next_data (self, bool soft_trigger=True)
None	receiveData (self, data, timestamp)
Public Member Functions inherited from microscope.abc.Device
None	__init__ (self)
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)
def	get_setting (self, str name)
def	get_all_settings (self)
None	set_setting (self, str name, value)
def	describe_setting (self, str name)
def	describe_settings (self)
def	update_settings (self, incoming, bool init=False)

Additional Inherited Members
Public Attributes inherited from microscope.abc.DataDevice
	enabled
Public Attributes inherited from microscope.abc.Device
	enabled
Static Public Attributes inherited from microscope.abc.Camera
list	ALLOWED_TRANSFORMS = [p for p in itertools.product(*3 * [[False, True]])]
Static Public Attributes inherited from microscope.abc.DataDevice
	set_setting = keep_acquiring(Device.set_setting)

Detailed Description

Ximea cameras

Args:
    serial_number: the serial number of the camera to connect to.
        It can be set to `None` if there is only camera on the
        system.

Definition at line 176 of file ximea.py.

Constructor & Destructor Documentation

__init__()

None microscope.cameras.ximea.XimeaCamera.__init__	(		self,
		typing.Optional[str]	buffer_length = None,
		**	kwargs
	)

Derived.__init__ must call this at some point.

Reimplemented from microscope.abc.Camera.

Definition at line 186 of file ximea.py.

    ) -> None:
        super().__init__(**kwargs)
        self._acquiring = False
        self._handle = xiapi.Camera()
        self._img = xiapi.Image()
        self._serial_number = serial_number
        self._sensor_shape = (0, 0)
        self._roi = microscope.ROI(None, None, None, None)
        self._binning = microscope.Binning(1, 1)
 
        # When using the Settings system, enums are not really enums
        # and even when using lists we get indices sent back and forth
        # (works fine only when using EnumInt.  The gymnastic here
        # makes it work with the rest of enums which are there to make
        # it work with TriggerTargetMixin.
        trg_source_names = [x.name for x in TrgSourceMap]
 
        def _trigger_source_setter(index: int) -> None:
            trigger_mode = TrgSourceMap[trg_source_names[index]].value
            self.set_trigger(trigger_mode, self.trigger_mode)
 
        self.add_setting(
            "trigger source",
            "enum",
            lambda: TrgSourceMap(self.trigger_type).name,
            _trigger_source_setter,
            trg_source_names,
        )
 
        self.initialize()
 

References microscope.cameras.ximea.XimeaCamera.__init__(), microscope.abc.DataDevice._acquiring, microscope.cameras.andorsdk3.AndorSDK3._acquiring(), microscope.cameras.atmcd.AndorAtmcd._acquiring(), microscope.cameras.picam.PiCamera._acquiring, microscope.cameras.pvcam.PVCamera._acquiring, microscope.cameras.ximea.XimeaCamera._acquiring, microscope.simulators.SimulatedCamera._acquiring, microscope.cameras.atmcd.AndorAtmcd._binning, microscope.cameras.ximea.XimeaCamera._binning, microscope.simulators.SimulatedCamera._binning, microscope.cameras.atmcd.AndorAtmcd._handle, microscope.cameras.ximea.XimeaCamera._handle, microscope.cameras.ximea.XimeaCamera._img, microscope.cameras.atmcd.AndorAtmcd._roi, microscope.cameras.ximea.XimeaCamera._roi, microscope.simulators.SimulatedCamera._roi, microscope.cameras.ximea.XimeaCamera._sensor_shape, microscope.cameras.andorsdk3.AndorSDK3._serial_number, microscope.cameras.ximea.XimeaCamera._serial_number, microscope.abc.Device.add_setting(), microscope.abc.Device.initialize(), microscope.cameras.andorsdk3.AndorSDK3.initialize(), microscope.cameras.atmcd.AndorAtmcd.initialize(), microscope.cameras.picam.PiCamera.initialize(), microscope.cameras.pvcam.PVCamera.initialize(), microscope.cameras.ximea.XimeaCamera.initialize(), microscope.lights.cobolt.CoboltLaser.initialize(), microscope.lights.obis.ObisLaser.initialize(), microscope.lights.sapphire.SapphireLaser.initialize(), microscope.testsuite.devices.TestFloatingDevice.initialize(), microscope._utils.OnlyTriggersOnceOnSoftwareMixin.set_trigger(), microscope._utils.OnlyTriggersBulbOnSoftwareMixin.set_trigger(), microscope.abc.TriggerTargetMixin.set_trigger(), microscope.cameras.andorsdk3.AndorSDK3.set_trigger(), microscope.cameras.atmcd.AndorAtmcd.set_trigger(), microscope.cameras.pvcam.PVCamera.set_trigger(), microscope.cameras.ximea.XimeaCamera.set_trigger(), microscope.controllers.coolled._CoolLEDChannel.set_trigger(), microscope.controllers.toptica._iChromeLaser.set_trigger(), microscope.lights.deepstar.DeepstarLaser.set_trigger(), microscope.lights.obis.ObisLaser.set_trigger(), microscope.cameras.picam.PiCamera.set_trigger(), microscope.mirror.alpao.AlpaoDeformableMirror.set_trigger(), microscope._utils.OnlyTriggersOnceOnSoftwareMixin.trigger_mode(), microscope._utils.OnlyTriggersBulbOnSoftwareMixin.trigger_mode(), microscope.abc.TriggerTargetMixin.trigger_mode(), microscope.cameras.andorsdk3.AndorSDK3.trigger_mode(), microscope.cameras.atmcd.AndorAtmcd.trigger_mode(), microscope.cameras.picam.PiCamera.trigger_mode(), microscope.cameras.pvcam.PVCamera.trigger_mode(), microscope.cameras.ximea.XimeaCamera.trigger_mode(), microscope.controllers.coolled._CoolLEDChannel.trigger_mode(), microscope.controllers.toptica._iChromeLaser.trigger_mode(), microscope.lights.deepstar.DeepstarLaser.trigger_mode(), microscope.lights.obis.ObisLaser.trigger_mode(), microscope.mirror.alpao.AlpaoDeformableMirror.trigger_mode(), microscope._utils.OnlyTriggersOnceOnSoftwareMixin.trigger_type(), microscope._utils.OnlyTriggersBulbOnSoftwareMixin.trigger_type(), microscope.abc.TriggerTargetMixin.trigger_type(), microscope.cameras.andorsdk3.AndorSDK3.trigger_type(), microscope.cameras.atmcd.AndorAtmcd.trigger_type(), microscope.cameras.picam.PiCamera.trigger_type(), microscope.cameras.pvcam.PVCamera.trigger_type(), microscope.cameras.ximea.XimeaCamera.trigger_type(), microscope.controllers.coolled._CoolLEDChannel.trigger_type(), microscope.controllers.toptica._iChromeLaser.trigger_type(), microscope.lights.deepstar.DeepstarLaser.trigger_type(), microscope.lights.obis.ObisLaser.trigger_type(), and microscope.mirror.alpao.AlpaoDeformableMirror.trigger_type().

Referenced by microscope.cameras.ximea.XimeaCamera.__init__().

Member Function Documentation

abort()

def microscope.cameras.ximea.XimeaCamera.abort

(

self

)

Stop acquisition as soon as possible.

Reimplemented from microscope.abc.DataDevice.

Definition at line 246 of file ximea.py.

    def abort(self):
        _logger.info("Disabling acquisition.")
        if self._acquiring:
            # We set acquiring before calling stop_acquisition because
            # the fetch loop is still running and will raise errors 45
            # otherwise.
            self._acquiring = False
            try:
                self._handle.stop_acquisition()
            except Exception:
                self._acquiring = True
                raise
 

References microscope.abc.DataDevice._acquiring, microscope.cameras.andorsdk3.AndorSDK3._acquiring(), microscope.cameras.atmcd.AndorAtmcd._acquiring(), microscope.cameras.picam.PiCamera._acquiring, microscope.cameras.pvcam.PVCamera._acquiring, microscope.cameras.ximea.XimeaCamera._acquiring, microscope.simulators.SimulatedCamera._acquiring, microscope.cameras.atmcd.AndorAtmcd._handle, and microscope.cameras.ximea.XimeaCamera._handle.

Referenced by microscope.simulators.SimulatedCamera.abort(), microscope.cameras.andorsdk3.AndorSDK3.get_id(), microscope.cameras.atmcd.AndorAtmcd.get_id(), microscope.cameras.picam.PiCamera.initialize(), microscope.cameras.ximea.XimeaCamera.initialize(), microscope.cameras.andorsdk3.AndorSDK3.set_trigger(), and microscope.abc.Device.update_settings().

get_cycle_time()

def microscope.cameras.ximea.XimeaCamera.get_cycle_time

(

self

)

Return the cycle time in seconds.

Reimplemented from microscope.abc.Camera.

Definition at line 359 of file ximea.py.

    def get_cycle_time(self):
        return 1.0 / self._handle.get_framerate()
 

References microscope.abc.DataDevice._acquiring, microscope.cameras.andorsdk3.AndorSDK3._acquiring(), microscope.cameras.atmcd.AndorAtmcd._acquiring(), microscope.cameras.picam.PiCamera._acquiring, microscope.cameras.pvcam.PVCamera._acquiring, microscope.cameras.ximea.XimeaCamera._acquiring, microscope.simulators.SimulatedCamera._acquiring, microscope.cameras.atmcd.AndorAtmcd._binning, microscope.cameras.ximea.XimeaCamera._binning, microscope.simulators.SimulatedCamera._binning, microscope.cameras.atmcd.AndorAtmcd._handle, microscope.cameras.ximea.XimeaCamera._handle, microscope.cameras.atmcd.AndorAtmcd._roi, microscope.cameras.ximea.XimeaCamera._roi, microscope.simulators.SimulatedCamera._roi, microscope.cameras.ximea.XimeaCamera._sensor_shape, microscope.cameras.picam.PiCamera._set_roi(), microscope.abc.Camera._set_roi(), microscope.cameras.ximea.XimeaCamera._set_roi(), microscope.cameras.andorsdk3.AndorSDK3._set_roi(), microscope.cameras.atmcd.AndorAtmcd._set_roi(), microscope.cameras.pvcam.PVCamera._set_roi(), microscope.simulators.SimulatedCamera._set_roi(), microscope.abc.TriggerTargetMixin.trigger(), and microscope.abc.DeformableMirror.trigger().

get_exposure_time()

float microscope.cameras.ximea.XimeaCamera.get_exposure_time

(

self

)

Return the current exposure time in seconds.

Reimplemented from microscope.abc.Camera.

Definition at line 355 of file ximea.py.

    def get_exposure_time(self) -> float:
        # exposure times are in us, so multiple by 1E-6 to get seconds.
        return self._handle.get_exposure() * 1.0e-6
 

References microscope.cameras.atmcd.AndorAtmcd._handle, and microscope.cameras.ximea.XimeaCamera._handle.

initialize()

None microscope.cameras.ximea.XimeaCamera.initialize

(

self

)

Initialise the camera.

Open the connection, connect properties and populate settings dict.

Reimplemented from microscope.abc.Device.

Definition at line 259 of file ximea.py.

    def initialize(self) -> None:
        """Initialise the camera.
 
        Open the connection, connect properties and populate settings dict.
        """
        n_cameras = self._handle.get_number_devices()
 
        if self._serial_number is None:
            if n_cameras > 1:
                raise TypeError(
                    "more than one Ximea camera found but the"
                    " serial_number argument was not specified"
                )
            _logger.info(
                "serial_number is not specified but there is only one"
                " camera on the system"
            )
            self._handle.open_device()
        else:
            _logger.info(
                "opening camera with serial number '%s'", self._serial_number
            )
            self._handle.open_device_by_SN(self._serial_number)
 
        self._sensor_shape = (
            self._handle.get_width_maximum()
            + self._handle.get_offsetX_maximum(),
            self._handle.get_height_maximum()
            + self._handle.get_offsetY_maximum(),
        )
        self._roi = microscope.ROI(
            left=0,
            top=0,
            width=self._sensor_shape[0],
            height=self._sensor_shape[1],
        )
        self.set_roi(self._roi)
 
        self.set_trigger(
            microscope.TriggerType.SOFTWARE, microscope.TriggerMode.ONCE
        )
 
        # Add settings for the different temperature sensors.
        for temp_param_name in [
            "chip_temp",
            "hous_temp",
            "hous_back_side_temp",
            "sensor_board_temp",
        ]:
            get_temp_method = getattr(self._handle, "get_" + temp_param_name)
            # Not all cameras have temperature sensors in all
            # locations.  We can't query if the sensor is there, we
            # can only try to read the temperature and skip that
            # temperature sensor if we get an exception.
            try:
                get_temp_method()
            except xiapi.Xi_error as err:
                # Depending on XiAPI version, camera model, and
                # selected sensor, we might get any of these errors as
                # meaning that it's not available.  See
                # https://github.com/python-microscope/vendor-issues/issues/6
                if err.status not in [
                    _XI_NOT_SUPPORTED,
                    _XI_NOT_IMPLEMENTED,
                    _XI_UNKNOWN_PARAM,
                ]:
                    raise
            else:
                self.add_setting(
                    temp_param_name,
                    "float",
                    get_temp_method,
                    None,
                    values=tuple(),
                )
 

References microscope.abc.DataDevice._acquiring, microscope.cameras.andorsdk3.AndorSDK3._acquiring(), microscope.cameras.atmcd.AndorAtmcd._acquiring(), microscope.cameras.picam.PiCamera._acquiring, microscope.cameras.pvcam.PVCamera._acquiring, microscope.cameras.ximea.XimeaCamera._acquiring, microscope.simulators.SimulatedCamera._acquiring, microscope.cameras.atmcd.AndorAtmcd._handle, microscope.cameras.ximea.XimeaCamera._handle, microscope.cameras.atmcd.AndorAtmcd._roi, microscope.cameras.ximea.XimeaCamera._roi, microscope.simulators.SimulatedCamera._roi, microscope.cameras.ximea.XimeaCamera._sensor_shape, microscope.cameras.andorsdk3.AndorSDK3._serial_number, microscope.cameras.ximea.XimeaCamera._serial_number, microscope.abc.DataDevice.abort(), microscope.cameras.andorsdk3.AndorSDK3.abort(), microscope.cameras.atmcd.AndorAtmcd.abort(), microscope.cameras.picam.PiCamera.abort(), microscope.cameras.pvcam.PVCamera.abort(), microscope.cameras.ximea.XimeaCamera.abort(), microscope.simulators.SimulatedCamera.abort(), microscope.abc.Device.add_setting(), microscope.abc.Camera.set_roi(), microscope._utils.OnlyTriggersOnceOnSoftwareMixin.set_trigger(), microscope._utils.OnlyTriggersBulbOnSoftwareMixin.set_trigger(), microscope.abc.TriggerTargetMixin.set_trigger(), microscope.cameras.andorsdk3.AndorSDK3.set_trigger(), microscope.cameras.atmcd.AndorAtmcd.set_trigger(), microscope.cameras.pvcam.PVCamera.set_trigger(), microscope.cameras.ximea.XimeaCamera.set_trigger(), microscope.controllers.coolled._CoolLEDChannel.set_trigger(), microscope.controllers.toptica._iChromeLaser.set_trigger(), microscope.lights.deepstar.DeepstarLaser.set_trigger(), microscope.lights.obis.ObisLaser.set_trigger(), microscope.cameras.picam.PiCamera.set_trigger(), and microscope.mirror.alpao.AlpaoDeformableMirror.set_trigger().

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

set_exposure_time()

None microscope.cameras.ximea.XimeaCamera.set_exposure_time	(		self,
		float	value
	)

Set the exposure time on the device in seconds.

Reimplemented from microscope.abc.Camera.

Definition at line 348 of file ximea.py.

    def set_exposure_time(self, value: float) -> None:
        # exposure times are set in us.
        try:
            self._handle.set_exposure_direct(int(value * 1000000))
        except Exception as err:
            _logger.debug("set_exposure_time exception: %s", err)
 

References microscope.cameras.atmcd.AndorAtmcd._handle, and microscope.cameras.ximea.XimeaCamera._handle.

set_trigger()

None microscope.cameras.ximea.XimeaCamera.set_trigger	(		self,
		microscope.TriggerType	ttype,
		microscope.TriggerMode	tmode
	)

Set device for a specific trigger.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 455 of file ximea.py.

    ) -> None:
        if tmode is not microscope.TriggerMode.ONCE:
            raise microscope.UnsupportedFeatureError(
                "%s not supported (only TriggerMode.ONCE)" % tmode
            )
 
        try:
            trg_source = TrgSourceMap(ttype)
        except ValueError:
            raise microscope.UnsupportedFeatureError(
                "no support for trigger type %s" % ttype
            )
 
        if trg_source.name != self._handle.get_trigger_source():
            # Changing trigger source requires stopping acquisition.
            with _disabled_camera(self):
                self._handle.set_trigger_source(trg_source.name)

References microscope.cameras.atmcd.AndorAtmcd._handle, and microscope.cameras.ximea.XimeaCamera._handle.

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

soft_trigger()

None microscope.cameras.ximea.XimeaCamera.soft_trigger

(

self

)

Definition at line 365 of file ximea.py.

    def soft_trigger(self) -> None:
        self.trigger()
 

Referenced by microscope.cameras.picam.PiCamera.get_cycle_time().

trigger_mode()

microscope.TriggerMode microscope.cameras.ximea.XimeaCamera.trigger_mode

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 434 of file ximea.py.

    def trigger_mode(self) -> microscope.TriggerMode:
        trg_selector = self._handle.get_trigger_selector()
        try:
            tmode = TrgSelectorMap[trg_selector]
        except KeyError:
            raise Exception(
                "somehow set to unsupported trigger mode %s" % trg_selector
            )
        return tmode.value
 

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

trigger_type()

microscope.TriggerType microscope.cameras.ximea.XimeaCamera.trigger_type

(

self

)

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 445 of file ximea.py.

    def trigger_type(self) -> microscope.TriggerType:
        trg_source = self._handle.get_trigger_source()
        try:
            ttype = TrgSourceMap[trg_source]
        except KeyError:
            raise Exception(
                "somehow set to unsupported trigger type %s" % trg_source
            )
        return ttype.value
 

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/cameras/ximea.py