Camera

Class Arguments

Argument	Type	Default Value
config_dict	dict
default_config	TStr

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Example Component Dictionary

   {
    "camera_example": {
        "classname": "atomiq.components.optoelectronics.camera.Camera",
        "arguments": {
            "config_dict": "<mandatory parameter (dict)>",
            "default_config": "<mandatory parameter (TStr)>"
        }
    }
}

Class Description

class atomiq.components.optoelectronics.camera.Camera(config_dict, default_config, *args, **kwargs)

Bases: Component

A Camera

This is an abstract class to represent a camera.

A camera needs to have a configuration (exposure time, readout mode, binning, subarray, etc). Since cameras usually need quite some config options to be set, this class works with named configuration sets stored in a dict. An example looks like the following:

config_dict = {
     "camera_usecase1" : {
             "option_xy": 2.3,
             "option_zy": "external",
             ...
     },
     "camera_usecase2": {
         "option_xy": 2e-3,
         "option_zy": "internal",
     },
     ...
}

Parameters:

• config_dict (dict) -- Dictionary holding the configuration sets for the camera

• default_config (TStr) -- key from the config dict to use if none is specified in the configure() function

configure(config='')

Configure the camera, i.e. set exposure time, readout mode, binning, etc. Named configuration options are available from the config_dict provided upon object creation. We load the one with the key given in config. If no key is given, load the default defined upon object creation.

Parameters:

config (artiq.compiler.types.TMono('str', OrderedDict()))

arm()

Arm the camera such that a subsequent call of the start() method can start the exposure immediately. Arming typically cannot meet realtime requirements. However, once armed, the camera can start exposure on a trigger in realtime

start()

Start exposure of the camera

stop()

Stop exposure of the camera