.. index:: pair: class; P1::ImageSdk::DecodeConfig
.. _doxid-class_p1_1_1_image_sdk_1_1_decode_config:

class P1::ImageSdk::DecodeConfig
================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Class used to configure the *Decode* pipline stages. :ref:`More...<details-class_p1_1_1_image_sdk_1_1_decode_config>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <P1ImageDecodeConfig.hpp>
	
	class DecodeConfig
	{
	public:
		// fields
	
		static const DecodeConfig :ref:`Defaults<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a618b45c7f0818d3c72e57a831c28f0b6>`;

		// construction
	
		:ref:`DecodeConfig<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a710c63483e2715bb4318943113b23993>`();
		:target:`DecodeConfig<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a0f2f09233c71ac8a836927b285f1fe8c>`(const DecodeConfig& other);

		// methods
	
		DecodeConfig& :target:`operator =<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1af7f9daf7fd08d2fada72b7ab2c68e5cb>` (const DecodeConfig& other);
		DecodeConfig& :target:`operator =<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a83f31d1f26ee71f11f85d6f3a60c6d53>` (DecodeConfig&& other);
		:ref:`BlackClamp<doxid-namespace_p1_1_1_image_sdk_1a1af9a3b0ef6e1b8b9d058d471d928b76>` :target:`GetBlackClamp<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a96fee99e0fcfc1250af50c4e14f6bcb4>`() const;
		:ref:`DigitalOffset<doxid-namespace_p1_1_1_image_sdk_1afd47bcace44d603bc0bcc26a0b417540>` :target:`GetDigitalOffset<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a09ad9b50ee3c7edf7f8ad91321178e8c>`() const;
		:ref:`DualExposureOutput<doxid-namespace_p1_1_1_image_sdk_1ac97a0c9b8a8035deb225b75bfcc82e55>` :target:`GetDualExposureOutput<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1aa0b2c4e6a62b2f53bcb198c0b8f09b7f>`() const;
		DecodeConfig :ref:`SetDualExposureOutput<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a4061ed248bc66939dd5603c0b9351262>`(:ref:`DualExposureOutput<doxid-namespace_p1_1_1_image_sdk_1ac97a0c9b8a8035deb225b75bfcc82e55>` mode);
	
		DecodeConfig :ref:`BlackLeveling<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1ad4d2859ecfef7de71fc0a1f867714e4c>`(
			:ref:`BlackClamp<doxid-namespace_p1_1_1_image_sdk_1a1af9a3b0ef6e1b8b9d058d471d928b76>` clamp = :ref:`BlackClamp::Default<doxid-namespace_p1_1_1_image_sdk_1a1af9a3b0ef6e1b8b9d058d471d928b76a7a1920d61156abc05a60135aefe8bc67>`,
			:ref:`DigitalOffset<doxid-namespace_p1_1_1_image_sdk_1afd47bcace44d603bc0bcc26a0b417540>` offset = :ref:`DigitalOffset::Default<doxid-namespace_p1_1_1_image_sdk_1afd47bcace44d603bc0bcc26a0b417540a7a1920d61156abc05a60135aefe8bc67>`
			);
	
		:ref:`SensorBayerOutput<doxid-class_p1_1_1_image_sdk_1_1_sensor_bayer_output>` :ref:`ApplyTo<doxid-class_p1_1_1_image_sdk_1_1_decode_config_1affa82e9ed068db912d6e5e28efac633e>`(const :ref:`RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& image);
	};
.. _details-class_p1_1_1_image_sdk_1_1_decode_config:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Class used to configure the *Decode* pipline stages.

Fields
------

.. index:: pair: variable; Defaults
.. _doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a618b45c7f0818d3c72e57a831c28f0b6:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	static const DecodeConfig Defaults

A static config object, configured with default static calibration values.

Construction
------------

.. index:: pair: function; DecodeConfig
.. _doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a710c63483e2715bb4318943113b23993:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	DecodeConfig()

Construct an empty configuration object.

Methods
-------

.. index:: pair: function; SetDualExposureOutput
.. _doxid-class_p1_1_1_image_sdk_1_1_decode_config_1a4061ed248bc66939dd5603c0b9351262:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	DecodeConfig SetDualExposureOutput(:ref:`DualExposureOutput<doxid-namespace_p1_1_1_image_sdk_1ac97a0c9b8a8035deb225b75bfcc82e55>` mode)

Specify how dual exposures are merged.

.. index:: pair: function; BlackLeveling
.. _doxid-class_p1_1_1_image_sdk_1_1_decode_config_1ad4d2859ecfef7de71fc0a1f867714e4c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	DecodeConfig BlackLeveling(
		:ref:`BlackClamp<doxid-namespace_p1_1_1_image_sdk_1a1af9a3b0ef6e1b8b9d058d471d928b76>` clamp = :ref:`BlackClamp::Default<doxid-namespace_p1_1_1_image_sdk_1a1af9a3b0ef6e1b8b9d058d471d928b76a7a1920d61156abc05a60135aefe8bc67>`,
		:ref:`DigitalOffset<doxid-namespace_p1_1_1_image_sdk_1afd47bcace44d603bc0bcc26a0b417540>` offset = :ref:`DigitalOffset::Default<doxid-namespace_p1_1_1_image_sdk_1afd47bcace44d603bc0bcc26a0b417540a7a1920d61156abc05a60135aefe8bc67>`
		)

Configure Black clamping and Digital offseting as part of the static calibration.

.. index:: pair: function; ApplyTo
.. _doxid-class_p1_1_1_image_sdk_1_1_decode_config_1affa82e9ed068db912d6e5e28efac633e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`SensorBayerOutput<doxid-class_p1_1_1_image_sdk_1_1_sensor_bayer_output>` ApplyTo(const :ref:`RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& image)

Apply this configuration to an actual :ref:`RawImage <doxid-class_p1_1_1_image_sdk_1_1_raw_image>`.