IR LED Calibration
==================

.. automodule:: jii_multispeq_protocols.protocols.calibrations.ir_led_calibration
  :members:
  :undoc-members:
  :show-inheritance:
  :no-index:
  :no-title:

Basic Usage
-----------

.. code-block:: python
  :caption: *Example:* Import statement for the **ir_led_calibration** protocol

  ## Import ir_led_calibration
  from jii_multispeq_protocols.protocols.calibrations import ir_led_calibration as _ir_led_calibration

----

Sequence
--------

.. mermaid::

   %%{
   init: {
     "theme": "base",
     "themeVariables": {"primaryColor": "#49e06d", "primaryTextColor": "#005e5e", "primaryBorderColor": "#005e5e", "lineColor": "#fff381", "secondaryColor": "#afd7f4", "tertiaryColor": "#D7EBF9"}
   }
   }%%
   flowchart TD
   	START((Start))
   	A0["`**Protocol**
   Runs only during *first* repeat`"]:::protocol
   	START ==> A0
   	A1["`**@s0**
   *Detector:* 
   *Pulsed LED:* 
   *Non Pulsed LED:* 530nm (Main)`"]:::protocol
   	A0 ==> A1
   	A1 ==> END
   	A1 -.-> |5x| A0
   	linkStyle 3 stroke-width:3px
   	END(( End ))
   	classDef protocol text-align:left,white-space:pre;


----

Details
-------



Code
~~~~

.. code-block:: python
   :caption: Protocol Code
   
   [  {  '_protocol_set_': [  {  'alert': 'Stack panels #1 and #9 and place in '
                                          'clamp',
                                 'bleed_correction': 0,
                                 'do_once': 1},
                              {  'detectors': [['@s1']],
                                 'label': '@s0',
                                 'nonpulsed_lights': [[1]],
                                 'nonpulsed_lights_brightness': [[-1]],
                                 'protocol_repeats': '#l2',
                                 'pulse_distance': [5000],
                                 'pulse_length': [['@s4']],
                                 'pulsed_lights': [['@s0']],
                                 'pulsed_lights_brightness': [['@p2']],
                                 'pulses': [1]}],
         'set_repeats': '#l0',
         'v_arrays': [  [6, 8, 9, 10, 5],
                        [1, 1, 1, 1, 1],
                        [  -20,
                           -50,
                           -100,
                           -200,
                           -400,
                           -600,
                           -1000,
                           -1500,
                           -2000,
                           -4000],
                        [2250, 2250, 2250, 2250, 2250],
                        [7, 7, 7, 7, 2]]}]




----

Analysis
--------


Usage
~~~~~

.. code-block:: python
  :caption: Analysis Example (requires ``JII-MultispeQ`` package)

  from jii_multispeq import measurement as _measurement
  from jii_multispeq_protocols.protocols.calibrations import ir_led_calibration as _ir_led_calibration

  ## Take a measurement using the MultispeQ
  data, crc32 = _measurement.measure(port="<Selected Port>", protocol=_ir_led_calibration, filename=None, notes="")

  ## The analyze function of JII-MultispeQ helps to provide the correct format
  output = _measurement.analyze( data, _ir_led_calibration._analyze )

  ## View Analysis output (as table)
  _measurement.view( output )

Function Details
~~~~~~~~~~~~~~~~

.. autofunction:: jii_multispeq_protocols.protocols.calibrations.ir_led_calibration._analyze
  :no-index:



Example Data
~~~~~~~~~~~~

===============  =================================================================================================================================================================================================================================================================================================================================================================================================================================================
Parameter        Value
===============  =================================================================================================================================================================================================================================================================================================================================================================================================================================================
device_battery   99
device_firmware  2.311
device_id        52:00:12:b7
device_name      MultispeQ
device_version   2
LEDs             [6, 8, 9, 10, 5]
par10            [0, 0, 0, 1, 702, 1833, 4259, 7386, 10551, 24179]
par5             [0, 0, 406, 3172, 9436, 16037, 29249, 46031, 62851, 62673]
par6             [0, 0, 2, 174, 603, 1030, 1858, 2890, 3895, 7786]
par8             [2451, 2452, 2452, 2649, 3241, 3823, 4980, 6392, 7792, 13240]
par9             [0, 0, 0, 59, 311, 574, 1073, 1695, 2312, 4729]
settings         [-20, -50, -100, -200, -400, -600, -1000, -1500, -2000, -4000]
time             1591560748952
toDevice         par_to_dac_lin+6+150.0+417.0+683.0+1217.0+2283.0+4095+4095+par_to_dac_lin+8+150.0+417.0+683.0+1217.0+2283.0+4095+4095+par_to_dac_lin+9+150.0+417.0+683.0+1217.0+2283.0+4095+4095+par_to_dac_lin+10+150.0+283.0+417.0+683.0+1217.0+2817.0+4095+par_to_dac_lin+5+150.0+190.0+230.0+310.0+470.0+950.0+1750.0+par_max_setting+5+4095+par_max_setting+6+4095+par_max_setting+8+4095+par_max_setting+9+4095+par_max_setting+10+4095+setCalTime+3+hello+
===============  =================================================================================================================================================================================================================================================================================================================================================================================================================================================