.. _image-decode-pipeline-label:

Decode Pipeline
~~~~~~~~~~~~~~~

The *Decode* pipeline takes the compressed Bayer image from an IIQ file and decodes it into ``SensorBayerOutput``. This output can be used for e.g. scientific analysis. The output is Bayer sensor output, with the option of applying static calibration. It is, thus not a "viewable" image, but rather a way of decoding the raw Bayer data from the image.

.. image:: decode-detail.png
    :width: 75%
    :alt: The decode pipeline stages
    :align: center

The Configuration Object
^^^^^^^^^^^^^^^^^^^^^^^^

To use the *Decode* pipeline, you create a ``DecodeConfig`` object. The ``DecodeConfig`` is considered the "recipe" for the pipeline. In the following example, we set the "recipe" to default. This returns a ``DecodeConfig`` object with pre-configured values. Is it also possible to use ``new`` on the ``DecodeConfig``, but you should only do so if you wish to create a specific configurations. We recommend that you use the default configuration.

.. TODO: For the full list of possible configurations, see Appendix E.

.. code-tabs::
    .. include-tab:: ../../labels/cppDecodeConfig
        :language: cpp
        :title: C++

    .. include-tab:: ../../labels/csDecodeConfig
        :language: csharp
        :title: C#

Applying to an Image
""""""""""""""""""""

You apply the configured decompression and static calibration to the previously opened image (see :ref:`image-open-label`), use ``config.ApplyTo``, as seen below:

.. code-tabs::
    .. include-tab:: ../../labels/cppApplyDecode
        :language: cpp
        :title: C++

    .. include-tab:: ../../labels/csApplyDecode
        :language: csharp
        :title: C#

.. note:: The output of the *Decode* pipeline is not an RGB image. It is sensor Bayer output, also known as *RAW*.