:orphan:

Kinetix
=======

**From:** `Teledyne Technologies <https://www.teledynevisionsolutions.com/products/kinetix/?vertical=tvs-photometrics&segment=tvs>`_

**Class:** :py:class:`herosdevices.hardware.teledyne.pvcam.Kinetix`


**Driver Quality Index:** beta


.. admonition:: Requires the following packages 

   ``pyvcam``

Driver class for the Kinetix camera.

This class adds the following device specific functionality:

- The trigger delay stored in the :py:attr:`Kinetix.trigger_delay` is calculated from the user specified trigger
  delay and the delay from the trigger input to the `All Rows` condition.

For more information refer to :py:class:`PvcamCamera`

.. note::

   It is well possible to that other PVCam cameras that support the fake global shutter concept (e.g. defined
   `All Rows` condition) can also be used with this driver.


.. tabs:: 


   .. tab:: Arguments
   
   
      Bold arguments are mandatory. For more information on the listed arguments refer to the class             documentation: :py:class:`herosdevices.hardware.teledyne.pvcam.Kinetix` 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
         * - **cam_id**
           - **<class 'str'>**
           - 
           - 
         * - **config_dict**
           - **<class 'dict'>**
           - 
           - 
         * - default_config
           - str | None
           - None
           - 
         * - lib_path
           - str | None
           - None
           - 
      

   .. tab:: Example JSON for BOSS
   
      This JSON string can be used to start a HERO device representation of             :py:class:`Kinetix <herosdevices.hardware.teledyne.pvcam.Kinetix>` using             `BOSS <https://boss-eb4966.gitlab.io/>`_.
      
      .. code-block:: json
      
         {
             "_id": "my_Kinetix",
             "classname": "herosdevices.hardware.teledyne.pvcam.Kinetix",
             "arguments": {
                 "cam_id": "<class 'str'>",
                 "config_dict": "<class 'dict'>",
                 "default_config": null,
                 "lib_path": null
             }
         }
      
   .. tab:: Inheritance
   
   
      .. inheritance-diagram:: herosdevices.hardware.teledyne.pvcam.Kinetix
      
