herosdevices.core.templates.camera¶

Templates for creating camera device representations.

Module Contents¶

class herosdevices.core.templates.camera.CameraTemplate[source]¶

Bases: herosdevices.interfaces.atomiq.Camera, herosdevices.core.templates.acq_device.AcquisitionDeviceTemplate

Template (base class) for cameras.

To make a functional camera device, the user needs to implement all abstract methods. The camera helper hooks (_get_*/_set_* for exposure time, ROI, binning, gain and frame rate) are optional. A feature counts as supported if the subclass overrides both hooks of its pair, see supported_features(). Hooks that are not overridden raise FeatureNotSupportedError. In addition, this call does not cover the mechanism the actually retrieve the image buffers from the device since it is typically special to each camera vendor/API. A general guideline should be to start a separate thread for the acquisition which uses the _acquisition_lock to prohibit concurrent exposures. For each received image, the event acquisition_data() should be called. In addition, acquisition_stopped() should be emitted after the acquisition.

get_camera¶

supported_features() → list[str][source]¶

Return the names of the camera helper features this class supports.

A feature is supported if the class overrides both its getter and its setter hook. If only one of the two is overridden, a warning is logged once per class and the feature is treated as unsupported.

Returns:: sorted feature names, equal to the names of the corresponding properties

property exposure_time: float | None¶: Exposure time in seconds. None if not set or not supported, see supported_features().

property roi_coordinates: tuple[int, int, int, int] | None¶

ROI as (x_offset, y_offset, width, height) in sensor pixels.

None if not set or not supported, see supported_features().

property binning: tuple[int, int] | None¶: Binning as (horizontal, vertical). None if not set or not supported, see supported_features().

property gain: float | None¶

Gain in the native unit of the driver, see Gain and frame rate.

The setter raises ValueError for NaN, infinity, booleans and non-numbers. The valid range is driver specific and checked by the driver. The getter returns None if not set or not supported, see supported_features().

property frame_rate: float | None¶

Frame rate limit in Hz, see Gain and frame rate.

Setting None removes the limit. Other values must be positive finite numbers, not booleans, otherwise the setter raises ValueError. The getter returns None if the limit is removed, if no frame rate is configured and if the feature is not supported, see supported_features().

acquisition_running: bool = False¶

payload_metadata: dict¶

default_config_dict: dict¶

keep_device_open = True¶

default_config: str¶

get_device() → collections.abc.Iterator[None]¶

Yield a device handle.

# use the device in a with statement
with self.get_device() as camera:
    camera.do_something()

open() → Any¶: Open the device handler and assign it to self._device.

teardown() → None¶: Release the device handler and potentially de-initialize the API.

start() → bool¶

Fire a software trigger.

Returns:: True if successful

stop() → bool¶

Abort the exposure and release queued buffers.

Returns:: True if successful

reset() → None¶: Reset the device by aborting any ongoing exposure, closing and re-opening the handler.

get_status() → dict¶

Get a dict with the current device status.

Returns:: A dict with the device status

get_available_options() → dict¶

Get all configurable options/features of the device.

Returns:: Dict mapping option names to their properties (value, readable, writable, etc.).

property config_dict: dict¶

Get a copy of the configuration dict.

Returns:: Copy of the configuration dict

update_configuration(new_config_dict: dict, merge: bool = True) → None¶

Update the configuration dict with new configuration.

Each dict key corresponds a (new) configuration name. Each value is a dict with config property -> config value.

Parameters:

new_config_dict – A dict of configurations where the keys are the configuration names
merge – If True, the new dict is recursively merged with the current set config dict. If False the old configurations with the provided names (keys) are overwritten. In this case each new configuration, merged over default_config_dict, must contain all _required_config_keys.

Raises:

ValueError – If merge is False and a required config key is missing. No configuration is changed.

get_configuration() → dict¶

Get the currently active configuration.

Returns:: The currently active configuration.

configure(config: str = '', metadata: dict | None = None) → bool¶

Configure the device with the known configuration config.

To add a configuration to the device, use update_configuration().

Parameters:

config – Key (name) of the configuration
metadata – Metadata that is merged into the current payload metadata dict which is send with every emitted acquisition_data event.

Returns:

False if the acquisition is running or if _set_config() returned False, True otherwise. Exceptions raised by _set_config() are not caught.

set_configuration¶

update_payload_metadata(metadata: dict, merge: bool = True) → None¶

Update metadata dict send with every emitted frame by the acquisition_data event method.

Parameters:

metadata – Metadata that is merged into the current payload metadata dict which is send with every emitted acquisition_data event.
merge – If True, the new dict is merged with the current set metadata dict. If False the old metadata is overwritten by the given dict.

arm(metadata: dict | None = None, kill_running: bool = False) → bool¶

Arm the device with the currently active configuration.

Parameters:

metadata – Metadata that is merged into the current payload metadata dict which is send with every emitted acquisition_data event.
kill_running – If True any running acquisition will be stopped. If False and an acquisition is
running (already)
raised. (an error will be)

Returns:

True if arming was successful else False

acquisition_data(frame: numpy.ndarray, metadata: dict | None = None) → tuple¶

Event to emit new frames.

Note

The dtype of the frame is not changed here.

Parameters:

frame – The frame payload data (for example an image or an scope trace)
metadata – The metadata which is passed along the payload. This argument takes precedence over the payload_metadata attribute (for example set by the update_payload_metadata method) while merging the two dicts.

Returns:

A tuple of image and metadata(-dict)

acquisition_started(metadata: dict | None = None) → dict¶

Event emitted when the acquisition thread starts.

Returns:: A dict with acquisition metadata

acquisition_stopped(metadata: dict | None = None) → dict¶

Event emitted when the acquisition thread stops.

Returns:: A dict with acquisition metadata