Inheritance diagram for microscope.abc.Camera:

Public Member Functions
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)

Static Public Attributes
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)

Additional Inherited Members
Public Attributes inherited from microscope.abc.DataDevice
	enabled

Public Attributes inherited from microscope.abc.Device
	enabled

Detailed Description

Adds functionality to :class:`DataDevice` to support cameras.

Defines the interface for cameras.  Applies a transform to
acquired data in the processing step.

Definition at line 819 of file abc.py.

Constructor & Destructor Documentation

◆ init()

None microscope.abc.Camera.__init__	(		self,
		**	buffer_length
	)

Derived.__init__ must call this at some point.

Reimplemented from microscope.abc.DataDevice.

Reimplemented in microscope.simulators.SimulatedCamera, microscope.testsuite.devices.TestCamera, microscope.cameras.picam.PiCamera, microscope.simulators.stage_aware_camera.StageAwareCamera, and microscope.cameras.ximea.XimeaCamera.

Definition at line 829 of file abc.py.

    def __init__(self, **kwargs) -> None:
        super().__init__(**kwargs)
        # A list of readout mode descriptions.
        self._readout_modes = ["default"]
        # The index of the current readout mode.
        self._readout_mode = 0
        # Transforms to apply to data (fliplr, flipud, rot90)
        # Transform to correct for readout order.
        self._readout_transform = (False, False, False)
        # Transform supplied by client to correct for system geometry.
        self._client_transform = (False, False, False)
        # Result of combining client and readout transforms
        self._transform = (False, False, False)
        # A transform provided by the client.
        self.add_setting(
            "transform",
            "enum",
            lambda: Camera.ALLOWED_TRANSFORMS.index(self._transform),
            lambda index: self.set_transform(Camera.ALLOWED_TRANSFORMS[index]),
            Camera.ALLOWED_TRANSFORMS,
        )
        self.add_setting(
            "readout mode",
            "enum",
            lambda: self._readout_mode,
            self.set_readout_mode,
            lambda: self._readout_modes,
        )
        self.add_setting("roi", "tuple", self.get_roi, self.set_roi, None)
 

Referenced by microscope.abc.Camera.__init__().

Member Function Documentation

◆ get_binning()

microscope.Binning microscope.abc.Camera.get_binning ( self )

Return the current binning corrected for transform.

Definition at line 933 of file abc.py.

    def get_binning(self) -> microscope.Binning:
        """Return the current binning corrected for transform."""
        binning = self._get_binning()
        if self._transform[2]:
            # 90 degree rotation
            binning = microscope.Binning(binning[1], binning[0])
        return binning
 

Referenced by microscope.cameras.atmcd.AndorAtmcd.initialize(), and microscope.abc.Camera.set_roi().

◆ get_cycle_time()

float microscope.abc.Camera.get_cycle_time ( self )

Return the cycle time in seconds.

Reimplemented in microscope.cameras.andorsdk3.AndorSDK3, microscope.cameras.atmcd.AndorAtmcd, microscope.cameras.picam.PiCamera, microscope.cameras.pvcam.PVCamera, microscope.cameras.ximea.XimeaCamera, and microscope.simulators.SimulatedCamera.

Definition at line 911 of file abc.py.

    def get_cycle_time(self) -> float:
        """Return the cycle time in seconds."""
        pass
 

◆ get_exposure_time()

float microscope.abc.Camera.get_exposure_time ( self )

Return the current exposure time in seconds.

Reimplemented in microscope.cameras.andorsdk3.AndorSDK3, microscope.cameras.atmcd.AndorAtmcd, microscope.cameras.picam.PiCamera, microscope.cameras.pvcam.PVCamera, microscope.cameras.ximea.XimeaCamera, and microscope.simulators.SimulatedCamera.

Definition at line 907 of file abc.py.

    def get_exposure_time(self) -> float:
        """Return the current exposure time in seconds."""
        pass
 

◆ get_roi()

microscope.ROI microscope.abc.Camera.get_roi ( self )

Return current ROI.

Definition at line 961 of file abc.py.

    def get_roi(self) -> microscope.ROI:
        """Return current ROI."""
        roi = self._get_roi()
        if self._transform[2]:
            # 90 degree rotation
            roi = microscope.ROI(roi[1], roi[0], roi[3], roi[2])
        return roi
 

References microscope.abc.Camera._get_roi(), microscope.cameras.andorsdk3.AndorSDK3._get_roi(), microscope.cameras.atmcd.AndorAtmcd._get_roi(), microscope.cameras.picam.PiCamera._get_roi(), microscope.cameras.pvcam.PVCamera._get_roi(), microscope.cameras.ximea.XimeaCamera._get_roi(), microscope.simulators.SimulatedCamera._get_roi(), and microscope.abc.Camera._transform.

Referenced by microscope.abc.Camera.__init__(), microscope.cameras.atmcd.AndorAtmcd.initialize(), and microscope.cameras.andorsdk3.AndorSDK3.set_trigger().

◆ get_sensor_shape()

typing.Tuple[int, int] microscope.abc.Camera.get_sensor_shape ( self )

Return a tuple of `(width, height)` corrected for transform.

Definition at line 920 of file abc.py.

    def get_sensor_shape(self) -> typing.Tuple[int, int]:
        """Return a tuple of `(width, height)` corrected for transform."""
        shape = self._get_sensor_shape()
        if self._transform[2]:
            # 90 degree rotation
            shape = (shape[1], shape[0])
        return shape
 

Referenced by microscope.abc.Camera.set_roi().

◆ get_transform()

def microscope.abc.Camera.get_transform ( self )

Return the current transform without readout transform.

Definition at line 880 of file abc.py.

    def get_transform(self):
        """Return the current transform without readout transform."""
        return self._client_transform
 

◆ set_binning()

None microscope.abc.Camera.set_binning	(		self,
		microscope.Binning	binning
	)

Set binning along both axes.  Return `True` if successful.

Definition at line 946 of file abc.py.

    def set_binning(self, binning: microscope.Binning) -> None:
        """Set binning along both axes.  Return `True` if successful."""
        h_bin, v_bin = binning
        if self._transform[2]:
            # 90 degree rotation
            binning = microscope.Binning(v_bin, h_bin)
        else:
            binning = microscope.Binning(h_bin, v_bin)
        return self._set_binning(binning)
 

References microscope.cameras.andorsdk3.AndorSDK3._set_binning(), microscope.cameras.atmcd.AndorAtmcd._set_binning(), microscope.cameras.pvcam.PVCamera._set_binning(), microscope.simulators.SimulatedCamera._set_binning(), microscope.cameras.picam.PiCamera._set_binning(), microscope.abc.Camera._set_binning(), microscope.cameras.ximea.XimeaCamera._set_binning(), and microscope.abc.Camera._transform.

Referenced by microscope.cameras.atmcd.AndorAtmcd.initialize().

◆ set_exposure_time()

None microscope.abc.Camera.set_exposure_time	(		self,
		float	value
	)

Set the exposure time on the device in seconds.

Reimplemented in microscope.cameras.ximea.XimeaCamera, microscope.cameras.andorsdk3.AndorSDK3, microscope.cameras.atmcd.AndorAtmcd, microscope.cameras.picam.PiCamera, microscope.cameras.pvcam.PVCamera, and microscope.simulators.SimulatedCamera.

Definition at line 903 of file abc.py.

    def set_exposure_time(self, value: float) -> None:
        """Set the exposure time on the device in seconds."""
        pass
 

◆ set_readout_mode()

def microscope.abc.Camera.set_readout_mode	(	self,
		description
	)

Set the readout mode and _readout_transform.

Reimplemented in microscope.cameras.pvcam.PVCamera.

Definition at line 876 of file abc.py.

    def set_readout_mode(self, description):
        """Set the readout mode and _readout_transform."""
        pass
 

Referenced by microscope.abc.Camera.__init__(), and microscope.cameras.pvcam.PVCamera.initialize().

◆ set_roi()

None microscope.abc.Camera.set_roi	(		self,
		microscope.ROI	roi
	)

Set the ROI according to the provided rectangle.

Return True if ROI set correctly, False otherwise.

Definition at line 974 of file abc.py.

    def set_roi(self, roi: microscope.ROI) -> None:
        """Set the ROI according to the provided rectangle.
 
        Return True if ROI set correctly, False otherwise.
        """
        maxw, maxh = self.get_sensor_shape()
        binning = self.get_binning()
        left, top, width, height = roi
        if not width:  # 0 or None
            width = maxw // binning.h
        if not height:  # 0 or None
            height = maxh // binning.v
        if self._transform[2]:
            roi = microscope.ROI(left, top, height, width)
        else:
            roi = microscope.ROI(left, top, width, height)
        return self._set_roi(roi)
 
 

References 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.Camera._transform, microscope.abc.Camera.get_binning(), and microscope.abc.Camera.get_sensor_shape().

Referenced by microscope.abc.Camera.__init__(), microscope.cameras.atmcd.AndorAtmcd.initialize(), and microscope.cameras.ximea.XimeaCamera.initialize().

◆ set_transform()

def microscope.abc.Camera.set_transform	(	self,
		transform
	)

Combine provided transform with readout transform.

Definition at line 884 of file abc.py.

    def set_transform(self, transform):
        """Combine provided transform with readout transform."""
        if isinstance(transform, str):
            transform = literal_eval(transform)
        self._client_transform = transform
        lr, ud, rot = (
            self._readout_transform[i] ^ transform[i] for i in range(3)
        )
        if self._readout_transform[2] and self._client_transform[2]:
            lr = not lr
            ud = not ud
        self._transform = (lr, ud, rot)
 

References microscope.abc.Camera._client_transform, microscope.abc.Camera._readout_transform, microscope.abc.Camera._transform, and microscope.abc.Camera.set_transform().

Referenced by microscope.abc.Camera.__init__(), and microscope.abc.Camera.set_transform().

Member Data Documentation

◆ ALLOWED_TRANSFORMS

list microscope.abc.Camera.ALLOWED_TRANSFORMS = [p for p in itertools.product(*3 * [[False, True]])]

static

Definition at line 827 of file abc.py.

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

F:/repos/BioImager/BioImager/PythonMicroscope/microscope/abc.py

Public Member Functions

Static Public Attributes

Additional Inherited Members