:orphan:

DCAM Camera
===========

**From:** Hamamatsu Photonics

**Class:** :py:class:`herosdevices.hardware.hamamatsu.dcam_camera.DcamCompatibleCamera`


**Driver Quality Index:** beta


.. admonition:: Requires the following packages 

   `dcamsdk4 <https://www.hamamatsu.com/eu/en/product/cameras/software/driver-software/dcam-sdk4.html>`_

.. include:: /hardware/hamamatsu_dcam.rst
Camera object for Hamamatsu DCAM cameras.

In particular, this code has been tested with the C15550-20UP.

.. tabs:: 


   .. tab:: Arguments
   
   
      Bold arguments are mandatory. For more information on the listed arguments refer to the class             documentation: :py:class:`herosdevices.hardware.hamamatsu.dcam_camera.DcamCompatibleCamera` If parameters appear in this             list but not in the class definition, please recursively check the linked base classes for the             definition of the parameter.
      
      
      .. list-table:: 
         :widths: 50 50 50 100
         :header-rows: 1
      
         * - Argument
           - Type
           - Default Value
           - Description
         * - **config_dict**
           - **<class 'dict'>**
           - 
           - Configuration dictionary, see EXAMPLE_CONFIG
         * - default_config
           - str | None
           - None
           - 
         * - keep_device_open
           - <class 'bool'>
           - True
           - Keep the device open after it is first opened
         * - payload_metadata
           - dict | None
           - None
           - 
      

   .. tab:: Example JSON for BOSS
   
      The following JSON strings can be used to start a HERO device representation of             :py:class:`DcamCompatibleCamera <herosdevices.hardware.hamamatsu.dcam_camera.DcamCompatibleCamera>` using             `BOSS <https://boss-eb4966.gitlab.io/>`_.
      
      .. code-block:: json
      
         {
             "_id": "orca",
             "classname": "herosdevices.hardware.hamamatsu.DcamCompatibleCamera",
             "arguments": {
                 "keep_device_open": true,
                 "config_dict": {
                     "default": {
                         "DCAM_IDPROP.TRIGGERSOURCE": "DCAMPROP.TRIGGERSOURCE.INTERNAL",
                         "DCAM_IDPROP.TRIGGERPOLARITY": "DCAMPROP.TRIGGERPOLARITY.POSITIVE",
                         "DCAM_IDPROP.EXPOSURETIME": 0.01,
                         "DCAM_IDPROP.SENSORMODE": "DCAMPROP.SENSORMODE.AREA",
                         "DCAM_IDPROP.BINNING": "DCAMPROP.BINNING._4",
                         "DCAM_IDPROP.SUBARRAYHSIZE": 200,
                         "DCAM_IDPROP.SUBARRAYVSIZE": 200,
                         "DCAM_IDPROP.SUBARRAYHPOS": 136,
                         "DCAM_IDPROP.SUBARRAYVPOS": 468,
                         "DCAM_IDPROP.SUBARRAYMODE": "DCAMPROP.MODE.ON",
                         "frame_count": 1,
                         "timeout": 5
                     }
                 }
             }
         }
      
      :sup:`from examples/hamamatsu/orca.json` 
      
      
      .. code-block:: json
      
         {
             "_id": "my_DcamCompatibleCamera",
             "classname": "herosdevices.hardware.hamamatsu.dcam_camera.DcamCompatibleCamera",
             "arguments": {
                 "config_dict": "<class 'dict'>",
                 "default_config": null,
                 "keep_device_open": true,
                 "payload_metadata": null
             }
         }
      
      :sup:`generated from signature`
   .. tab:: Inheritance
   
   
      .. inheritance-diagram:: herosdevices.hardware.hamamatsu.dcam_camera.DcamCompatibleCamera