Inheritance diagram for microscope.simulators.SimulatedCamera:

Public Member Functions
def	__init__ (self, **kwargs)

def	abort (self)

def	set_exposure_time (self, value)

def	get_exposure_time (self)

def	get_cycle_time (self)

def	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
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.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.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

Definition at line 154 of file __init__.py.

Constructor & Destructor Documentation

◆ init()

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

Derived.__init__ must call this at some point.

Reimplemented from microscope.abc.Camera.

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

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
 

Referenced by microscope.simulators.SimulatedCamera.__init__().

Member Function Documentation

◆ abort()

def 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
 

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.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
 

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.andorsdk3.AndorSDK3._exposure_time, microscope.cameras.picam.PiCamera._exposure_time, microscope.simulators.SimulatedCamera._exposure_time, microscope.cameras.atmcd.AndorAtmcd._roi, microscope.cameras.ximea.XimeaCamera._roi, microscope.simulators.SimulatedCamera._roi, microscope.cameras.picam.PiCamera._triggered, microscope.simulators.SimulatedCamera._triggered, microscope.simulators.stage_aware_camera.StageAwareCamera._triggered, microscope.abc.TriggerTargetMixin.trigger(), and microscope.abc.DeformableMirror.trigger().

◆ get_exposure_time()

def 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
 

References microscope.cameras.andorsdk3.AndorSDK3._exposure_time, microscope.cameras.picam.PiCamera._exposure_time, and microscope.simulators.SimulatedCamera._exposure_time.

◆ set_exposure_time()

def 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
 

References microscope.cameras.andorsdk3.AndorSDK3._exposure_time, microscope.cameras.picam.PiCamera._exposure_time, and microscope.simulators.SimulatedCamera._exposure_time.

◆ soft_trigger()

def microscope.simulators.SimulatedCamera.soft_trigger ( self )

Definition at line 283 of file __init__.py.

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

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

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

F:/repos/BioImager/BioImager/PythonMicroscope/microscope/simulators/__init__.py

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ abort()

◆ get_cycle_time()

◆ get_exposure_time()

◆ set_exposure_time()

◆ soft_trigger()

◆ init()