.. _doxcsid-class_p1_1_1_image_sdk_1_1_decode_config:

DecodeConfig Class
~~~~~~~~~~~~~~~~~~

Definition
^^^^^^^^^^

*Namespace:* ``P1.ImageSdk``

Defines a set of decoding flags, that can be used on a raw image :ref:`More...<csdetails-class_p1_1_1_image_sdk_1_1_decode_config>`

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

	public class DecodeConfig


.. _csdetails-class_p1_1_1_image_sdk_1_1_decode_config:

Remarks
^^^^^^^

Defines a set of decoding flags, that can be used on a raw image

This class lets you configure decoding options and decode an raw image. You obtain an instance of this class be using :ref:`RawImage.Decode <doxcsid-class_p1_1_1_image_sdk_1_1_raw_image_1a6db4a16eaf821470b1c8bdc1b0af0c25>`. After calls to decoding option methods like :ref:`BlackLeveling <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1a7c03693150511b42cb27ff19d3c11df9>`, you must call :ref:`ApplyTo <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1aaaaa7beebfa3e7d4ea64ab3272ac8d3e>` to trigger the actual decoding.

This class handles only decoding and/or decompressing raw image data, not raw convertion. For raw converyion see :ref:`ConvertConfig <doxcsid-class_p1_1_1_image_sdk_1_1_convert_config>`.

// Simple one-liner raw file decompression, and custom static calibration var rawBitmap = new :ref:`DecodeConfig() <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1ab8f2687da7dcfb2766691dca7feef758>`.BlackLeveling(:ref:`BlackClamp.Default <doxcsid-namespace_p1_1_1_image_sdk_1a1af9a3b0ef6e1b8b9d058d471d928b76a7a1920d61156abc05a60135aefe8bc67>`, :ref:`DigitalOffset.Keep <doxcsid-namespace_p1_1_1_image_sdk_1afd47bcace44d603bc0bcc26a0b417540a02bce93bff905887ad2233110bf9c49e>`).AppleTo(new :ref:`RawImage <doxcsid-class_p1_1_1_image_sdk_1_1_raw_image>` ("some-file.iiq"));



.. rubric:: See also:

:ref:`RawImage.Decode <doxcsid-class_p1_1_1_image_sdk_1_1_raw_image_1a6db4a16eaf821470b1c8bdc1b0af0c25>`


Constructors
^^^^^^^^^^^^

.. toctree::
	:hidden:	

	DecodeConfig <function_P1_ImageSdk_DecodeConfig_DecodeConfig.rst>

.. list-table::
	:widths: 30 70

	*
		- :ref:`DecodeConfig() <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1ab8f2687da7dcfb2766691dca7feef758>`
		- Creates a new decoding options object, with no options configured

Properties
^^^^^^^^^^

.. toctree::
	:hidden:

	BlackClamp <variable_P1_ImageSdk_DecodeConfig_BlackClamp.rst>
	DigitalOffset <variable_P1_ImageSdk_DecodeConfig_DigitalOffset.rst>

.. list-table::
	:widths: 30 70

	*
		- :ref:`BlackClamp <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1a29f7a57e49aee2006ef754dc93087cd4>`
		- 
	*
		- :ref:`DigitalOffset <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1af0acf1c58c002865e773f6ac6e5e3992>`
		- 

Methods
^^^^^^^

.. toctree::
	:hidden:

	BlackLeveling <function_P1_ImageSdk_DecodeConfig_BlackLeveling.rst>
	ApplyTo <function_P1_ImageSdk_DecodeConfig_ApplyTo.rst>
	Defaults <function_P1_ImageSdk_DecodeConfig_Defaults.rst>

.. list-table::
	:widths: 33 67

	* 
		- :ref:`BlackLeveling(BlackClamp clamp=ImageSdk.BlackClamp.On, DigitalOffset digitalOffset=DigitalOffset.Default) <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1a7c03693150511b42cb27ff19d3c11df9>`
		- Control how to calibrate pixel's black point, using black clamping and digital offset
	* 
		- :ref:`ApplyTo(RawImage image, Func\< UInt32, byte[]> allocFunction=null) <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1aaaaa7beebfa3e7d4ea64ab3272ac8d3e>`
		- Trigger decoding of the applied options on the raw-image and return a new image as a RAW data bitmap
	* 
		- :ref:`Defaults() <doxcsid-class_p1_1_1_image_sdk_1_1_decode_config_1a7270b1ce6783c267f2dd4d7715f6a032>`
		- Returns a predefined config object, with sensibel options enabled already