Inheritance diagram for microscope.simulators.SimulatedCamera:

Public Member Functions
	__init__ (self, **kwargs)

	abort (self)

	set_exposure_time (self, value)

	get_exposure_time (self)

	get_cycle_time (self)

	soft_trigger (self)

Public Member Functions inherited from microscope._utils.OnlyTriggersOnceOnSoftwareMixin
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.Camera
	set_readout_mode (self, description)

	get_transform (self)

	set_transform (self, transform)

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.DataDevice
	__del__ (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)

	grab_next_data (self, bool soft_trigger=True)

None	receiveData (self, data, timestamp)

Public Member Functions inherited from microscope.abc.Device
bool	get_is_enabled (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)

Public Attributes
int	_acquiring = 1

Public Attributes inherited from microscope.abc.Camera
	set_readout_mode

	get_roi

	set_roi

Public Attributes inherited from microscope.abc.DataDevice
bool	enabled = False

bool	_fetch_thread = True

bool	_dispatch_thread = True

None	_fetch_thread_run = self._fetch_data()

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

Protected Member Functions
	_set_error_percent (self, value)

	_set_gain (self, value)

	_purge_buffers (self)

	_create_buffers (self)

	_fetch_data (self)

	_do_disable (self)

	_do_enable (self)

	_get_sensor_shape (self)

None	_do_trigger (self)

	_get_binning (self)

	_set_binning (self, binning)

	_get_roi (self)

	_set_roi (self, roi)

None	_do_shutdown (self)

Protected Member Functions inherited from microscope.abc.TriggerTargetMixin
Protected Member Functions inherited from microscope.abc.Camera
	_process_data (self, data)

	_set_readout_transform (self, new_transform)

Protected Member Functions inherited from microscope.abc.DataDevice
	_send_data (self, client, data, timestamp)

None	_dispatch_loop (self)

None	_fetch_loop (self)

	_client (self)

	_client (self, val)

None	_put (self, data, timestamp)

Protected Member Functions inherited from microscope.abc.Device

Protected Attributes
	_roi = microscope.ROI(0, 0, 512, 512)

	_binning = microscope.Binning(1, 1)

	_image_generator = _ImageGenerator()

int	_a_setting = 0

int	_error_percent = 0

	_set_error_percent

int	_gain = 0

	_set_gain

bool	_acquiring = False

float	_exposure_time = 0.1

int	_triggered = 0

int	_sent = 0

Protected Attributes inherited from microscope.abc.Camera
list	_readout_modes = ["default"]

int	_readout_mode = 0

tuple	_readout_transform = (False, False, False)

tuple	_client_transform = (False, False, False)

tuple	_transform = (False, False, False)

Protected Attributes inherited from microscope.abc.DataDevice
	_fetch_thread = None

bool	_fetch_thread_run = False

bool	_using_callback = False

list	_clientStack = []

	_liveClients = set()

	_dispatch_thread = None

	_dispatch_buffer = queue.Queue(maxsize=buffer_length)

bool	_acquiring = False

	_new_data_condition = threading.Condition()

	_client = None

tuple	_new_data = (data, timestamp)

Protected Attributes inherited from microscope.abc.Device
dict	_settings = {}

Additional Inherited Members
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

Definition at line 154 of file __init__.py.

Constructor & Destructor Documentation

◆ init()

microscope.simulators.SimulatedCamera.__init__	(		self,
		**	buffer_length )

Derived.__init__ must call this at some point.

Reimplemented from microscope.abc.Camera.

Reimplemented in microscope.simulators.stage_aware_camera.StageAwareCamera, and microscope.testsuite.devices.TestCamera.

Definition at line 157 of file __init__.py.

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        # Binning and ROI
        self._roi = microscope.ROI(0, 0, 512, 512)
        self._binning = microscope.Binning(1, 1)
        # Function used to generate test image
        self._image_generator = _ImageGenerator()
        self.add_setting(
            "image pattern",
            "enum",
            self._image_generator.method,
            self._image_generator.set_method,
            self._image_generator.get_methods,
        )
        self.add_setting(
            "image data type",
            "enum",
            self._image_generator.data_type,
            self._image_generator.set_data_type,
            self._image_generator.get_data_types,
        )
        self.add_setting(
            "display image number",
            "bool",
            lambda: self._image_generator.numbering,
            self._image_generator.enable_numbering,
            None,
        )
        # Software buffers and parameters for data conversion.
        self._a_setting = 0
        self.add_setting(
            "a_setting",
            "int",
            lambda: self._a_setting,
            lambda val: setattr(self, "_a_setting", val),
            lambda: (1, 100),
        )
        self._error_percent = 0
        self.add_setting(
            "_error_percent",
            "int",
            lambda: self._error_percent,
            self._set_error_percent,
            lambda: (0, 100),
        )
        self._gain = 0
        self.add_setting(
            "gain",
            "int",
            lambda: self._gain,
            self._set_gain,
            lambda: (0, 8192),
        )
        self._acquiring = False
        self._exposure_time = 0.1
        self._triggered = 0
        # Count number of images sent since last enable.
        self._sent = 0
 

Member Function Documentation

◆ _create_buffers()

microscope.simulators.SimulatedCamera._create_buffers ( self )

protected

Create buffers and store values needed to remove padding later.

Definition at line 227 of file __init__.py.

    def _create_buffers(self):
        """Create buffers and store values needed to remove padding later."""
        self._purge_buffers()
        _logger.info("Creating buffers.")
 

◆ _do_disable()

microscope.simulators.SimulatedCamera._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 258 of file __init__.py.

    def _do_disable(self):
        self.abort()
 

◆ _do_enable()

microscope.simulators.SimulatedCamera._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 261 of file __init__.py.

    def _do_enable(self):
        _logger.info("Preparing for acquisition.")
        if self._acquiring:
            self.abort()
        self._create_buffers()
        self._acquiring = True
        self._sent = 0
        _logger.info("Acquisition enabled.")
        return True
 

◆ _do_shutdown()

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

    def _do_shutdown(self) -> None:
        pass

◆ _do_trigger()

None microscope.simulators.SimulatedCamera._do_trigger ( self )

protected

Actual trigger of the device.

Classes implementing this interface should implement this
method instead of `trigger`.

Reimplemented from microscope.abc.TriggerTargetMixin.

Definition at line 287 of file __init__.py.

    def _do_trigger(self) -> None:
        _logger.info(
            "Trigger received; self._acquiring is %s.", self._acquiring
        )
        if self._acquiring:
            self._triggered += 1
 

◆ _fetch_data()

microscope.simulators.SimulatedCamera._fetch_data ( self )

protected

Poll for data and return it, with minimal processing.

If the device uses buffering in software, this function should
copy the data from the buffer, release or recycle the buffer,
then return a reference to the copy.  Otherwise, if the SDK
returns a data object that will not be written to again, this
function can just return a reference to the object.  If no
data is available, return `None`.

Reimplemented from microscope.abc.DataDevice.

Reimplemented in microscope.simulators.stage_aware_camera.StageAwareCamera.

Definition at line 232 of file __init__.py.

    def _fetch_data(self):
        if self._acquiring and self._triggered > 0:
            if random.randint(0, 100) < self._error_percent:
                _logger.info("Raising exception")
                raise microscope.DeviceError(
                    "Exception raised in SimulatedCamera._fetch_data"
                )
            _logger.info("Sending image")
            time.sleep(self._exposure_time)
            self._triggered -= 1
            # Create an image
            dark = int(32 * np.random.rand())
            light = int(255 - 128 * np.random.rand())
            width = self._roi.width // self._binning.h
            height = self._roi.height // self._binning.v
            image = self._image_generator.get_image(
                width, height, dark, light, index=self._sent
            )
            self._sent += 1
            return image
 

◆ _get_binning()

microscope.simulators.SimulatedCamera._get_binning ( self )

protected

Return the current binning.

Reimplemented from microscope.abc.Camera.

Definition at line 294 of file __init__.py.

    def _get_binning(self):
        return self._binning
 

◆ _get_roi()

microscope.simulators.SimulatedCamera._get_roi ( self )

protected

Return the ROI as it is on hardware.

Reimplemented from microscope.abc.Camera.

Definition at line 301 of file __init__.py.

    def _get_roi(self):
        return self._roi
 

◆ _get_sensor_shape()

microscope.simulators.SimulatedCamera._get_sensor_shape ( self )

protected

Return a tuple of `(width, height)` indicating shape in pixels.

Reimplemented from microscope.abc.Camera.

Definition at line 280 of file __init__.py.

    def _get_sensor_shape(self):
        return (512, 512)
 

◆ _purge_buffers()

microscope.simulators.SimulatedCamera._purge_buffers ( self )

protected

Purge buffers on both camera and PC.

Definition at line 223 of file __init__.py.

    def _purge_buffers(self):
        """Purge buffers on both camera and PC."""
        _logger.info("Purging buffers.")
 

◆ _set_binning()

microscope.simulators.SimulatedCamera._set_binning	(		self,
			binning )

protected

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

Reimplemented from microscope.abc.Camera.

Definition at line 298 of file __init__.py.

    def _set_binning(self, binning):
        self._binning = binning
 

◆ _set_error_percent()

microscope.simulators.SimulatedCamera._set_error_percent	(		self,
			value )

protected

Definition at line 216 of file __init__.py.

    def _set_error_percent(self, value):
        self._error_percent = value
        self._a_setting = value // 10
 

◆ _set_gain()

microscope.simulators.SimulatedCamera._set_gain	(		self,
			value )

protected

Definition at line 220 of file __init__.py.

    def _set_gain(self, value):
        self._gain = value
 

◆ _set_roi()

microscope.simulators.SimulatedCamera._set_roi	(		self,
			roi )

protected

Set the ROI on the hardware.  Return `True` if successful.

Reimplemented from microscope.abc.Camera.

Definition at line 305 of file __init__.py.

    def _set_roi(self, roi):
        self._roi = roi
 

◆ abort()

microscope.simulators.SimulatedCamera.abort ( self )

Stop acquisition as soon as possible.

Reimplemented from microscope.abc.DataDevice.

Definition at line 253 of file __init__.py.

    def abort(self):
        _logger.info("Disabling acquisition; %d images sent.", self._sent)
        if self._acquiring:
            self._acquiring = False
 

◆ get_cycle_time()

microscope.simulators.SimulatedCamera.get_cycle_time ( self )

Return the cycle time in seconds.

Reimplemented from microscope.abc.Camera.

Definition at line 277 of file __init__.py.

    def get_cycle_time(self):
        return self._exposure_time
 

◆ get_exposure_time()

microscope.simulators.SimulatedCamera.get_exposure_time ( self )

Return the current exposure time in seconds.

Reimplemented from microscope.abc.Camera.

Definition at line 274 of file __init__.py.

    def get_exposure_time(self):
        return self._exposure_time
 

◆ set_exposure_time()

microscope.simulators.SimulatedCamera.set_exposure_time	(		self,
			value )

Set the exposure time on the device in seconds.

Reimplemented from microscope.abc.Camera.

Definition at line 271 of file __init__.py.

    def set_exposure_time(self, value):
        self._exposure_time = value
 

◆ soft_trigger()

microscope.simulators.SimulatedCamera.soft_trigger ( self )

Definition at line 283 of file __init__.py.

    def soft_trigger(self):
        # deprecated, use self.trigger()
        self.trigger()
 

Member Data Documentation

◆ _a_setting

int microscope.simulators.SimulatedCamera._a_setting = 0

protected

Definition at line 186 of file __init__.py.

◆ _acquiring [1/2]

bool microscope.simulators.SimulatedCamera._acquiring = False

protected

Definition at line 210 of file __init__.py.

◆ _acquiring [2/2]

int microscope.simulators.SimulatedCamera._acquiring = 1

Definition at line 291 of file __init__.py.

◆ _binning

microscope.simulators.SimulatedCamera._binning = microscope.Binning(1, 1)

protected

Definition at line 161 of file __init__.py.

◆ _error_percent

microscope.simulators.SimulatedCamera._error_percent = 0

protected

Definition at line 194 of file __init__.py.

◆ _exposure_time

microscope.simulators.SimulatedCamera._exposure_time = 0.1

protected

Definition at line 211 of file __init__.py.

◆ _gain

microscope.simulators.SimulatedCamera._gain = 0

protected

Definition at line 202 of file __init__.py.

◆ _image_generator

microscope.simulators.SimulatedCamera._image_generator = _ImageGenerator()

protected

Definition at line 163 of file __init__.py.

◆ _roi

microscope.simulators.SimulatedCamera._roi = microscope.ROI(0, 0, 512, 512)

protected

Definition at line 160 of file __init__.py.

◆ _sent

int microscope.simulators.SimulatedCamera._sent = 0

protected

Definition at line 214 of file __init__.py.

◆ _set_error_percent

microscope.simulators.SimulatedCamera._set_error_percent

protected

Definition at line 199 of file __init__.py.

◆ _set_gain

microscope.simulators.SimulatedCamera._set_gain

protected

Definition at line 207 of file __init__.py.

◆ _triggered

int microscope.simulators.SimulatedCamera._triggered = 0

protected

Definition at line 212 of file __init__.py.

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

BioImager/PythonMicroscope/microscope/simulators/__init__.py

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _create_buffers()

◆ _do_disable()

◆ _do_enable()

◆ _do_shutdown()

◆ _do_trigger()

◆ _fetch_data()

◆ _get_binning()

◆ _get_roi()

◆ _get_sensor_shape()

◆ _purge_buffers()

◆ _set_binning()

◆ _set_error_percent()

◆ _set_gain()

◆ _set_roi()

◆ abort()

◆ get_cycle_time()

◆ get_exposure_time()

◆ set_exposure_time()

◆ soft_trigger()

Member Data Documentation

◆ _a_setting

◆ _acquiring [1/2]

◆ _acquiring [2/2]

◆ _binning

◆ _error_percent

◆ _exposure_time

◆ _gain

◆ _image_generator

◆ _roi

◆ _sent

◆ _set_error_percent

◆ _set_gain

◆ _triggered

◆ init()