.. index:: pair: class; P1::ImageSdk::ConvertConfig
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config:

class P1::ImageSdk::ConvertConfig
=================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Class that configures the *Convert* pipeline stages. :ref:`More...<details-class_p1_1_1_image_sdk_1_1_convert_config>`


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

	#include <P1ImageConvertConfig.hpp>
	
	class ConvertConfig
	{
	public:
		// fields
	
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`ExposureRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aab7ced9acc2bfb760b0a01aaefc4e11b>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`ContrastRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1a6e5a7587397f5c224a4e46c8965ca6>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`BrightnessRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a77788b630c4616193a6708f7b18011f9>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`SaturationRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7a2e9e111961f02a01f423a3080202aa>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`HighlightRecoveryRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6ecd8d5c0d00a08526d26d584fa953bc>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`ShadowRecoveryRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a64ca10d8071b50a03901f99f2dc0e4c6>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`BlackLevelRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6199b16ff05e45af25677268bfdbf806>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`WhiteLevelRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1eeda6acf34515be9e3e77c3787016b1>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`MidtoneLevelRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a554873460b655c7075898d277bc96217>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<double> :ref:`CurveInOutRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5c71589b1033fd8868630396ceee807c>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<int> :ref:`ClarityMethodRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1adb1ca60e16a8448431ead2f685002b9b>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`ClarityAmountRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a261439929686afb69aaee38165ebfe1e>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<int> :ref:`NoiseReductionRadiusRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a43b90655fe2b1d922d6d7f4eb6c5a83d>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`WhiteBalanceGainRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a34153447704a701b48f7024e5cecb5df>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`GeometricCorrectionFocalLengthRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7f000f20a10d342a45e9b65d6a0bb0cb>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`GeometricCorrectionPixelPitchRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aaa99c8270bd07fceffb99fc0fb0821af>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`GeometricCorrectionShiftRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2f294fd8d34aa3b11ce30f2b6fa0bd20>`;
		static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> :ref:`GeometricCorrectionPolinomRange<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a28723167907a5d919069a65f2695b4df>`;

		// construction
	
		:target:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1affc3bd75eaa11deb099fadbcf1dc1b02>`();
		:target:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1bafb989d5cbfe26dbf826d3921bffef>`(const ConvertConfig& other);

		// methods
	
		ConvertConfig& :target:`operator =<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ae6250ea942e86ec3d5ee750eca0a8c27>` (const ConvertConfig& other);
		:ref:`CanvasClip<doxid-namespace_p1_1_1_image_sdk_1a1d547bdd93d336ee760646d69b8733fa>` :ref:`GetCanvasClip<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a244adc46be7ca778d647f3c15d3dcb85>`() const;
		ConvertConfig :ref:`SetCanvasClip<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a3bd77bd7dd2a8366e73ef47bc82e9a79>`(:ref:`CanvasClip<doxid-namespace_p1_1_1_image_sdk_1a1d547bdd93d336ee760646d69b8733fa>` canvasClip);
		:ref:`Rect<doxid-struct_p1_1_1_image_sdk_1_1_rect>` :ref:`GetCrop<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2a4159ad22d455f3b689f2eadbe0a88d>`() const;
		bool :target:`HasCrop<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a976a5b313de88dc78ef803a66bd13da1>`() const;
		bool :target:`HasOutputScaling<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab002d4de6cc7ab19dc5fe92d91da207a>`() const;
		double :ref:`GetOutputScale<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1afb5d96797c7e76c36587cafe87570b3e>`() const;
		int32_t :ref:`GetOutputWidth<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a63729913a212ee78a717b5f6acc7aca9>`() const;
		int32_t :ref:`GetOutputHeight<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1abddc7b21263cfde856da05850a938b5f>`() const;
		:ref:`BitmapFormat<doxid-namespace_p1_1_1_image_sdk_1aa5aef9c59675209aad9d961cfa29ba0a>` :ref:`GetOutputFormat<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7f95858ed602ad6e889f233fb9c470b9>`() const;
		ConvertConfig :ref:`SetCrop<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5f969867c757d9e041e416771f58815e>`(int32_t x, int32_t y, int32_t width, int32_t height);
		ConvertConfig :ref:`SetCrop<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a3dd92a05cfe8af91b4c70523898a3cfc>`(const :ref:`Rect<doxid-struct_p1_1_1_image_sdk_1_1_rect>`& cropRect);
		ConvertConfig :ref:`SetOutputScale<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ae176e374597e52f3edc7fbe8f47498bd>`(double scaleFactor);
		ConvertConfig :ref:`SetOutputWidth<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7d74266a244ea63b62338af475361e7d>`(int32_t destinationWidth);
		ConvertConfig :ref:`SetOutputHeight<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a8bb00945d545c837ecbc39b18fc5fc93>`(int32_t destinationHeight);
		ConvertConfig :ref:`SetOutputFormat<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a348d3a0776ebdd959f7b5f4e58542720>`(:ref:`BitmapFormat<doxid-namespace_p1_1_1_image_sdk_1aa5aef9c59675209aad9d961cfa29ba0a>` format);
		ConvertConfig :target:`SetNoiseModel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a005fc4c75dd1fb9f5808895619f25279>`(float param1, float param2);
		float :ref:`GetContrast<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a953584f2698f381ada9b4643c98ef08e>`() const;
		ConvertConfig :ref:`SetContrast<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2311dc6a2f3cbd1a04b94e0930f1c6fd>`(const float contrast);
		float :ref:`GetBrightness<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2fdcd3bc4029329fcb6c71cbc5d22c9c>`() const;
		ConvertConfig :ref:`SetBrightness<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1abd81410034f58dcabb16808f620637b8>`(const float brightness);
		float :ref:`GetSaturation<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5a5a8b6f786dd68caf3769c8b3a3eb0f>`() const;
		ConvertConfig :ref:`SetSaturation<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a54203020273de46982139bec7152f21d>`(const float saturation);
		float :ref:`GetExposure<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9e7e57cc938614a3133d3fcac4e114b1>`() const;
		ConvertConfig :ref:`SetExposure<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aff0865b0bdf0a0f49132284aed4cf7a4>`(const float exposure);
		float :ref:`GetGain<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ad9afdfe3f510ece989ea0ef4aba6db79>`() const;
		ConvertConfig :ref:`SetGain<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a4499478e30c8d6d3c304250c00aadb82>`(const float gain);
		:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` :ref:`GetBlackLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a8426f828ec29e9c6c9a37387c11195d7>`();
		ConvertConfig :ref:`SetBlackLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6d69d546ad7a529669f9ce91153e3b68>`(float r, float g, float b);
		ConvertConfig :ref:`SetBlackLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1abb3d796c0a1b63ec1e831fda24a05fc8>`(:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` color);
		:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` :ref:`GetMidtoneLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6b0f771d41c744783ad0a696c22b8b99>`();
		ConvertConfig :ref:`SetMidtoneLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a118c6aadd9d6a63869c2cb201d62bbb3>`(float r, float g, float b);
		ConvertConfig :ref:`SetMidtoneLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1034c9339f4c6be5ccc6344dd9957616>`(:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` color);
		:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` :ref:`GetWhiteLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2aa516e297e9057d3eb4940332bee77e>`();
		ConvertConfig :ref:`SetWhiteLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a811d4cff85e126415e78976d6e62f911>`(float r, float g, float b);
		ConvertConfig :ref:`SetWhiteLevel<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aada6b30895d7d9babf23ab4ba6a2123c>`(:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` color);
		ConvertConfig :ref:`SetBlackLevelTarget<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab295beca2ca4266f65b550a1b229b654>`(float r, float g, float b);
		ConvertConfig :ref:`SetWhiteLevelTarget<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aa87eeeda1a18589bed101c9fe876be5a>`(float r, float g, float b);
		float :ref:`GetSharpeningAmount<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ace9d9fb608674e7dc8e23cbc08efc702>`();
		ConvertConfig :ref:`SetSharpeningAmount<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1af80fc82dea061e25d272100452b99190>`(float sharpeningAmount);
		int :ref:`GetNoiseReductionRadiusAmount<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ad5adf9e30a1d83f8d72fc72cee9d675a>`();
		ConvertConfig :ref:`SetNoiseReductionRadiusAmount<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ac618860c1f0061c2328ccac6e153ade0>`(int noiseReductionRadius);
		:ref:`Clarity<doxid-struct_p1_1_1_image_sdk_1_1_clarity>` :ref:`GetClarity<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9ab070453842d4b26945480ed9bbb61d>`();
		ConvertConfig :ref:`SetClarity<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab74b9ef6a9d993f29cab15f47f1d2ace>`(int clarityMethod, float clarityFactor);
		ConvertConfig :ref:`SetClarity<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7f490c6404bf6e7984cc6393333efc5f>`(:ref:`Clarity<doxid-struct_p1_1_1_image_sdk_1_1_clarity>` clarity);
		float :ref:`GetShadowRecovery<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1afc2d9f65a9d5c3acaa023d01d7f8ef57>`() const;
		ConvertConfig :ref:`SetShadowRecovery<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6ac21c7ed2f88c23bcb0262ca7982065>`(const float shadowRecovery);
		float :ref:`GetHighlightRecovery<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2915fc1bfd4f8a21098e0adcfd0e3074>`() const;
		ConvertConfig :ref:`SetHighlightRecovery<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9fdfde92ae62ad048585a0759987cd4b>`(const float highlightRecovery);
		ConvertConfig :ref:`SetHistogramStage<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a370f3d227593e46b80d7ea2dc8df9fb0>`(const int stage);
		const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> :ref:`GetRedCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1af1dc005d47a6d51b9cb26f68d233e091>`();
		ConvertConfig :ref:`SetRedCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a18755e09386ef458324bfbbc60d4fdab>`(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points);
		const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> :ref:`GetGreenCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a0c213c95a6cf30c1601f924799838588>`();
		ConvertConfig :ref:`SetGreenCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a3bc0b00df7cfb23cf21d01fbfe1c11ba>`(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points);
		const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> :ref:`GetBlueCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aed229c85cc4a2c35c8d6263aaf7d1c5d>`();
		ConvertConfig :ref:`SetBlueCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a37758766609c78ac376d432f2c9c333e>`(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points);
		const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> :ref:`GetLumaCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5acaea1a8c4dc822898dcd302ba3ef2c>`();
		ConvertConfig :ref:`SetLumaCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a18220c1f0d30b1578b0ce5cc442a0330>`(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points);
		const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> :ref:`GetRgbCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a676c025ddecc165bd39db1ba45e0ba1c>`();
		ConvertConfig :ref:`SetRgbCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a874d52e089297808e34042357868b322>`(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points);
		const :ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` :ref:`GetWhiteBalanceGain<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab1e4cb56675342ea518e957a816dc99f>`() const;
		ConvertConfig :ref:`SetWhiteBalanceGain<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a8cf48084e52091be32b169aebc5464b4>`(const :ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` whiteBalanceGain);
		bool :ref:`GetGeomerticCorrectionEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5e5769bc6accbda71105ffff8c32528d>`() const;
		ConvertConfig :ref:`SetGeomerticCorrectionEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a76cfe16e3c284e73431d7ed1cb4b6a8d>`(const bool enable);
		const :ref:`GeometricCorrection<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` :ref:`GetGeometricCorrection<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a3bea5bf867fb2e17aa36f13476eff770>`() const;
		ConvertConfig :ref:`SetGeometricCorrection<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a99ac15ccb33d8653f74f4a487aa5a763>`(const :ref:`GeometricCorrection<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` geometricCorrection);
		bool :ref:`GetLightFalloffCorrectionEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ad7d7489a6cde1783ddcac248898a1dea>`() const;
		ConvertConfig :ref:`SetLightFalloffCorrectionEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a13dd650bad720dd5bbf847d7f27ba263>`(const bool enable);
		bool :ref:`GetChromaticAberrationCorrectionEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a431217649e66f7b810d9622c723db475>`() const;
		ConvertConfig :ref:`SetChromaticAberrationCorrectionEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ad0c9ebed28292025455922e5721331de>`(const bool enable);
		bool :ref:`GetExposureWarningMaskEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab1d718c2b051e9feedb5a7c70a68c5ea>`() const;
		ConvertConfig :ref:`SetExposureWarningMaskEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9028822ed944a65c42954df1ce212934>`(const bool enable);
		float :ref:`GetMaskThresholdOverExposure<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a687ec8d4a0c4c195d39dde00c2d4abb7>`();
		float :ref:`GetMaskThresholdUnderExposure<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a06f9a0dd79b649bb70811bd529f7bf68>`();
	
		ConvertConfig :ref:`SetExposureMaskThreadhold<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a00a378b4e2f64e81905e27d8da1ef833>`(
			float underExposeThreshold,
			float overExposeThreadhold
			);
	
		bool :ref:`GetClipWarningMaskEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a80dc121aa794a4ac6cb389099af3fba9>`() const;
		ConvertConfig :ref:`SetClipWarningMaskEnabled<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9e1a4b7c810a1373a20d4076288c8d54>`(bool enable);
		int :ref:`GetMaskThresholdClipWarningCount<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aca458810eef1997c84a9cdb46ea41661>`();
		ConvertConfig :ref:`SetMaskThresholdClipWarningCount<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a74bad099fce1518f6c426c0e030127e5>`(int thresholdCount);
		bool :ref:`GetEnableLinearPath<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ae1bfa4c30b82b8dcf25d28ff62c86d6f>`() const;
		ConvertConfig :ref:`SetEnableLinearPath<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a711a35a1ee66ee8013e0a0ebe38a6534>`(const bool enable);
	
		:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` :ref:`ApplyTo<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a4a484d957be2bbe45165951ec1fc5a49>`(
			const :ref:`RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& image,
			:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`* mask = nullptr,
			bool waitForBusySDK = true
			);
	
		void :ref:`SaveToFile<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aa59eeede09e63c05694bf5edabc6ddd8>`(const char* filename) const;
		std::string :ref:`Serialize<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a67784488e87a31e8b8993b5fae13166e>`() const;
		static ConvertConfig :ref:`LoadFromFile<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1298957c0219cee9859a3b05f6688c1e>`(const char* filename);
		static ConvertConfig :ref:`Deserialize<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1adc2b13765dd0403d4781fab6a5dfa015>`(const std::string serializedData);
	
		static std::vector<float> :ref:`DiscretizeCurve<doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a342076beaf3592814d66e4a143e4a791>`(
			const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points,
			unsigned int bits
			);
	};
.. _details-class_p1_1_1_image_sdk_1_1_convert_config:

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

Class that configures the *Convert* pipeline stages.

The convert config is where convertion from Bayer domain into the Rgb domain happens, you can configure cropping and scaling. The order is fixed. Also you can enable and setup different kinds of image enhancements algorithms, known from other image editing tools. Also it is possible to enable image corrections like lens distortion and light falloff.

Fields
------

.. index:: pair: variable; ExposureRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aab7ced9acc2bfb760b0a01aaefc4e11b:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> ExposureRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the Exposure value.

* Minimum: -4.0

* Maximum: 4.0

* Default: 0.0

.. index:: pair: variable; ContrastRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1a6e5a7587397f5c224a4e46c8965ca6:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> ContrastRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the Contrast value.

* Minimum: -1.0

* Maximum: 1.0

* Default: 0.0

.. index:: pair: variable; BrightnessRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a77788b630c4616193a6708f7b18011f9:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> BrightnessRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the Brightness value.

* Minimum: -1.0

* Maximum: 1.0

* Default: 0.0

.. index:: pair: variable; SaturationRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7a2e9e111961f02a01f423a3080202aa:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> SaturationRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the Saturation value.

* Minimum: -1.0

* Maximum: 1.0

* Default: 0.0

.. index:: pair: variable; HighlightRecoveryRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6ecd8d5c0d00a08526d26d584fa953bc:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> HighlightRecoveryRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the HighlightRecovery value.

* Minimum: 0.0

* Maximum: 1.0

* Default: 0.0

.. index:: pair: variable; ShadowRecoveryRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a64ca10d8071b50a03901f99f2dc0e4c6:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> ShadowRecoveryRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the ShadowRecovery value.

* Minimum: 0.0

* Maximum: 1.0

* Default: 0.0

.. index:: pair: variable; BlackLevelRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6199b16ff05e45af25677268bfdbf806:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> BlackLevelRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the BlackLevel value.

* Minimum: 0.0

* Maximum: 1.0

* Default: 0.0

.. index:: pair: variable; WhiteLevelRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1eeda6acf34515be9e3e77c3787016b1:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> WhiteLevelRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the WhiteLevel value.

* Minimum: 0.0

* Maximum: 1.0

* Default: 1.0

.. index:: pair: variable; MidtoneLevelRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a554873460b655c7075898d277bc96217:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> MidtoneLevelRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the MidtoneLevel value.

* Minimum: -1.0

* Maximum: 1.0

* Default: 0.0

.. index:: pair: variable; CurveInOutRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5c71589b1033fd8868630396ceee807c:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<double> CurveInOutRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the X and Y field of each element of the curve type properties.

* Minimum: 0.0

* Maximum: 1.0

* Default: 0.0

The properties this applies to are the following

* RedCurve

* BlueCurve

* GreenCurve

* LumaCurve

* RGBCurve

.. index:: pair: variable; ClarityMethodRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1adb1ca60e16a8448431ead2f685002b9b:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<int> ClarityMethodRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the Method field of the :ref:`Clarity <doxid-struct_p1_1_1_image_sdk_1_1_clarity>` value.

* Minimum: clarityMethodNeutral = 0

* Maximum: clarityMethodNatural = 2

* Default: clarityMethodNeutral = 0

.. index:: pair: variable; ClarityAmountRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a261439929686afb69aaee38165ebfe1e:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> ClarityAmountRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the Factor field of the :ref:`Clarity <doxid-struct_p1_1_1_image_sdk_1_1_clarity>` property.

* Minimum: -1.0

* Maximum: 1.0

* Default: 0.0

.. index:: pair: variable; NoiseReductionRadiusRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a43b90655fe2b1d922d6d7f4eb6c5a83d:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<int> NoiseReductionRadiusRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the NoiseReductionRadius property.

* Minimum: 0

* Maximum: 32

* Default: 0

.. index:: pair: variable; WhiteBalanceGainRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a34153447704a701b48f7024e5cecb5df:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> WhiteBalanceGainRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the RGB channels of the White Balance Gain property.

* Minimum: 0

* Maximum: 10.0

* Default: 0.0, meaning to use the metadata embedded into the IIQ file.

.. index:: pair: variable; GeometricCorrectionFocalLengthRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7f000f20a10d342a45e9b65d6a0bb0cb:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> GeometricCorrectionFocalLengthRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the focalLength field of the :ref:`GeometricCorrection <doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` value.

* Minimum: 23.0

* Maximum: 1000.0

.. index:: pair: variable; GeometricCorrectionPixelPitchRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aaa99c8270bd07fceffb99fc0fb0821af:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> GeometricCorrectionPixelPitchRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the pixelSize field of the :ref:`GeometricCorrection <doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` value.

* Minimum: 0.001

* Maximum: 0.05317

* Default: -1.0, indicating that the :ref:`GeometricCorrection <doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` is unset, and is not to be used.

.. index:: pair: variable; GeometricCorrectionShiftRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2f294fd8d34aa3b11ce30f2b6fa0bd20:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> GeometricCorrectionShiftRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the xP and yP fields of the :ref:`GeometricCorrection <doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` value.

* Minimum: -30.0

* Maximum: 30.0

* Default: 0.0

.. index:: pair: variable; GeometricCorrectionPolinomRange
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a28723167907a5d919069a65f2695b4df:

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

	static const :ref:`ValueRange<doxid-struct_p1_1_1_image_sdk_1_1_value_range>`<float> GeometricCorrectionPolinomRange

The :ref:`ValueRange <doxid-struct_p1_1_1_image_sdk_1_1_value_range>` of the k1, k2, k3, p1, p2, b1, b2 fields of the :ref:`GeometricCorrection <doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` value.

* Minimum: -1.0e-4

* Maximum: 1.0e-4

* Default: 0.0

Methods
-------

.. index:: pair: function; GetCanvasClip
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a244adc46be7ca778d647f3c15d3dcb85:

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

	:ref:`CanvasClip<doxid-namespace_p1_1_1_image_sdk_1a1d547bdd93d336ee760646d69b8733fa>` GetCanvasClip() const

Returns the current CanvasClip setting.

.. index:: pair: function; SetCanvasClip
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a3bd77bd7dd2a8366e73ef47bc82e9a79:

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

	ConvertConfig SetCanvasClip(:ref:`CanvasClip<doxid-namespace_p1_1_1_image_sdk_1a1d547bdd93d336ee760646d69b8733fa>` canvasClip)

Configure the output image canvas edge handling.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- canvasClip

		- The new CanvasClip setting.



.. rubric:: Returns:

This object itself (this), to allow chaining

.. index:: pair: function; GetCrop
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2a4159ad22d455f3b689f2eadbe0a88d:

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

	:ref:`Rect<doxid-struct_p1_1_1_image_sdk_1_1_rect>` GetCrop() const

Get any configured crop.

.. index:: pair: function; GetOutputScale
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1afb5d96797c7e76c36587cafe87570b3e:

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

	double GetOutputScale() const

Get any configured scaling factor, or a negative number, if none if set.

.. index:: pair: function; GetOutputWidth
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a63729913a212ee78a717b5f6acc7aca9:

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

	int32_t GetOutputWidth() const

Get any configured scaling by fixed output width, or a negative number, if none if set.

.. index:: pair: function; GetOutputHeight
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1abddc7b21263cfde856da05850a938b5f:

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

	int32_t GetOutputHeight() const

Get any configured scaling by fixed output height, or a negative number, if none if set.

.. index:: pair: function; GetOutputFormat
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7f95858ed602ad6e889f233fb9c470b9:

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

	:ref:`BitmapFormat<doxid-namespace_p1_1_1_image_sdk_1aa5aef9c59675209aad9d961cfa29ba0a>` GetOutputFormat() const

The data format of the pixels.

.. index:: pair: function; SetCrop
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5f969867c757d9e041e416771f58815e:

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

	ConvertConfig SetCrop(int32_t x, int32_t y, int32_t width, int32_t height)

Crop image to a given rectangle, in coordinates of the input image.

.. index:: pair: function; SetCrop
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a3dd92a05cfe8af91b4c70523898a3cfc:

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

	ConvertConfig SetCrop(const :ref:`Rect<doxid-struct_p1_1_1_image_sdk_1_1_rect>`& cropRect)

Crop image to a given rectangle, in coordinates of the input image.

.. index:: pair: function; SetOutputScale
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ae176e374597e52f3edc7fbe8f47498bd:

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

	ConvertConfig SetOutputScale(double scaleFactor)

Scale image relative to the full image size, with aspect ratio enforced.

.. index:: pair: function; SetOutputWidth
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7d74266a244ea63b62338af475361e7d:

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

	ConvertConfig SetOutputWidth(int32_t destinationWidth)

Set the scaling to match a given destination width, aspect ratio is still enforced.

.. index:: pair: function; SetOutputHeight
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a8bb00945d545c837ecbc39b18fc5fc93:

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

	ConvertConfig SetOutputHeight(int32_t destinationHeight)

Set the scaling to match a given destination height, aspect ratio is still enforced.

.. index:: pair: function; SetOutputFormat
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a348d3a0776ebdd959f7b5f4e58542720:

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

	ConvertConfig SetOutputFormat(:ref:`BitmapFormat<doxid-namespace_p1_1_1_image_sdk_1aa5aef9c59675209aad9d961cfa29ba0a>` format)

Set the pixel data format of the output image.

.. index:: pair: function; GetContrast
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a953584f2698f381ada9b4643c98ef08e:

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

	float GetContrast() const

Get the value of the contrast setting in the convert config. See also SetContrast function.

.. index:: pair: function; SetContrast
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2311dc6a2f3cbd1a04b94e0930f1c6fd:

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

	ConvertConfig SetContrast(const float contrast)

Adjust the contrast of the image.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- contrast

		- is a value between -1.0 and 1.0. Default is 0.0

.. index:: pair: function; GetBrightness
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2fdcd3bc4029329fcb6c71cbc5d22c9c:

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

	float GetBrightness() const

Get the value of the brightness setting in the convert config. See also SetBrightness function.

.. index:: pair: function; SetBrightness
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1abd81410034f58dcabb16808f620637b8:

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

	ConvertConfig SetBrightness(const float brightness)

Adjust the brightness of the image.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- brightness

		- is a value between -1.0 and 1.0. Default is 0.0

.. index:: pair: function; GetSaturation
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5a5a8b6f786dd68caf3769c8b3a3eb0f:

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

	float GetSaturation() const

Get the value of the saturation setting in the convert config. See also SetSaturation function.

.. index:: pair: function; SetSaturation
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a54203020273de46982139bec7152f21d:

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

	ConvertConfig SetSaturation(const float saturation)

Adjust the saturation of the image.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- saturation

		- is a value between -1.0 and 1.0. Default is 0.0

.. index:: pair: function; GetExposure
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9e7e57cc938614a3133d3fcac4e114b1:

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

	float GetExposure() const

Get the value of the exposure setting in the convert config. See also SetExposure function.

.. index:: pair: function; SetExposure
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aff0865b0bdf0a0f49132284aed4cf7a4:

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

	ConvertConfig SetExposure(const float exposure)

Adjust the exposure of the image.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- exposure

		- is a value between -4.0 and 4.0. Default is 0.0

.. index:: pair: function; GetGain
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ad9afdfe3f510ece989ea0ef4aba6db79:

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

	float GetGain() const

Get the value of the gain setting in the convert config. See also SetGain function.

.. index:: pair: function; SetGain
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a4499478e30c8d6d3c304250c00aadb82:

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

	ConvertConfig SetGain(const float gain)

Adjust the gain of the image - this is a variant of the exposure setting.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- gain

		- is a floating point value. Default is 1.0

.. index:: pair: function; GetBlackLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a8426f828ec29e9c6c9a37387c11195d7:

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

	:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` GetBlackLevel()

Get the black level setting in the convert config. See also SetBlackLevel functions.

.. index:: pair: function; SetBlackLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6d69d546ad7a529669f9ce91153e3b68:

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

	ConvertConfig SetBlackLevel(float r, float g, float b)

Set the black level. This is a color that is regarded as black



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- r

		- 

	*
		- g

		- 

	*
		- b

		- are values between 0.0 and 1.0. Default is 0.0

.. index:: pair: function; SetBlackLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1abb3d796c0a1b63ec1e831fda24a05fc8:

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

	ConvertConfig SetBlackLevel(:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` color)

Set the black level. This is a color that is regarded as black.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- color

		- where the r,g,b color is set as a struct.

.. index:: pair: function; GetMidtoneLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6b0f771d41c744783ad0a696c22b8b99:

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

	:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` GetMidtoneLevel()

Get the midtone level setting in the convert config. See also SetMidtoneLevel functions.

.. index:: pair: function; SetMidtoneLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a118c6aadd9d6a63869c2cb201d62bbb3:

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

	ConvertConfig SetMidtoneLevel(float r, float g, float b)

Set the midtone level. This is a color that is used as 50% level of the color values.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- r

		- 

	*
		- g

		- 

	*
		- b

		- are values between 0.0 and 1.0. Default is 0.0

.. index:: pair: function; SetMidtoneLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1034c9339f4c6be5ccc6344dd9957616:

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

	ConvertConfig SetMidtoneLevel(:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` color)

Set the midtone level. This is a color that is used as 50% level of the color values.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- color

		- where the r,g,b color is set as a struct.

.. index:: pair: function; GetWhiteLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2aa516e297e9057d3eb4940332bee77e:

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

	:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` GetWhiteLevel()

Get the white level setting in the convert config. See also SetWhiteLevel functions.

.. index:: pair: function; SetWhiteLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a811d4cff85e126415e78976d6e62f911:

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

	ConvertConfig SetWhiteLevel(float r, float g, float b)

Set the white level. This is a color that is regarded as white.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- r

		- 

	*
		- g

		- 

	*
		- b

		- are values between 0.0 and 1.0. Default is 0.0

.. index:: pair: function; SetWhiteLevel
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aada6b30895d7d9babf23ab4ba6a2123c:

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

	ConvertConfig SetWhiteLevel(:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` color)

Set the white level. This is a color that is regarded as white.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- color

		- where the r,g,b color is set as a struct.

.. index:: pair: function; SetBlackLevelTarget
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab295beca2ca4266f65b550a1b229b654:

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

	ConvertConfig SetBlackLevelTarget(float r, float g, float b)

Set the level used for black. This is a color that black color is mapped into (as in a level tool)



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- r

		- 

	*
		- g

		- 

	*
		- b

		- are values between 0.0 and 1.0. Default is 0.0

.. index:: pair: function; SetWhiteLevelTarget
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aa87eeeda1a18589bed101c9fe876be5a:

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

	ConvertConfig SetWhiteLevelTarget(float r, float g, float b)

Set the level used for white. This is a color that white color is mapped into (as in a level tool)



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- r

		- 

	*
		- g

		- 

	*
		- b

		- are values between 0.0 and 1.0. Default is 0.0

.. index:: pair: function; GetSharpeningAmount
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ace9d9fb608674e7dc8e23cbc08efc702:

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

	float GetSharpeningAmount()

Get the value of the sharpening amount in the convert config. See also SetSharpening function.

.. index:: pair: function; SetSharpeningAmount
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1af80fc82dea061e25d272100452b99190:

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

	ConvertConfig SetSharpeningAmount(float sharpeningAmount)

Adjust the amount of sharpening of the image.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- sharpeningAmount

		- is a value between -10.0 and 10.0. Default is 0.0

.. index:: pair: function; GetNoiseReductionRadiusAmount
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ad5adf9e30a1d83f8d72fc72cee9d675a:

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

	int GetNoiseReductionRadiusAmount()

Get the pixel radius used for the Noise Reduction algorithm to sample neighbouring pixels to reduce noise.

.. index:: pair: function; SetNoiseReductionRadiusAmount
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ac618860c1f0061c2328ccac6e153ade0:

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

	ConvertConfig SetNoiseReductionRadiusAmount(int noiseReductionRadius)

Sets the pixel radius used for the Noise Reduction algorithm to reduce noise.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- noiseReductionRadius

		- is a value between 0 and 32. Default is 0.

.. index:: pair: function; GetClarity
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9ab070453842d4b26945480ed9bbb61d:

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

	:ref:`Clarity<doxid-struct_p1_1_1_image_sdk_1_1_clarity>` GetClarity()

Get the setup of the clarity tool. See also SetClarity function for further explanation.

.. index:: pair: function; SetClarity
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab74b9ef6a9d993f29cab15f47f1d2ace:

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

	ConvertConfig SetClarity(int clarityMethod, float clarityFactor)

Setup the clarity tool. Its used as a tool to help control the local contrast in the image. A negative value will decrease local contrast and and positive increase it. Its a combination of selecting a method and a factor (amount)



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- clarityMethod

		- is the method used for clarity tool. It can be set to: clarityMethodNeutral = 0, clarityMethodPunch=1, clarityMethodNatural=2. Default is clarityMethodNeutral=0

	*
		- clarityFactor

		- is the value defining the factor used for the clarity tool. It is a value between -1.0 and 1.0. Default is 0.0 for disabled

.. index:: pair: function; SetClarity
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a7f490c6404bf6e7984cc6393333efc5f:

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

	ConvertConfig SetClarity(:ref:`Clarity<doxid-struct_p1_1_1_image_sdk_1_1_clarity>` clarity)

Setup the clarity tool. It's used as a tool to help control the local contrast in the image. A negative value will decrease local contrast and and positive increase it. Its a combination of selecting a method and a factor (amount)



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- clarity

		- is a struct with two members: the method and the factor. See :ref:`SetClarity(int clarityMethod, float clarityFactor) <doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab74b9ef6a9d993f29cab15f47f1d2ace>`

.. index:: pair: function; GetShadowRecovery
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1afc2d9f65a9d5c3acaa023d01d7f8ef57:

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

	float GetShadowRecovery() const

Get the value of the shadow recovery setting in the convert config. See also SetShadowRecovery function.

.. index:: pair: function; SetShadowRecovery
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a6ac21c7ed2f88c23bcb0262ca7982065:

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

	ConvertConfig SetShadowRecovery(const float shadowRecovery)

Set shadow recovery. Used to extract details only in the shadows of the image by making them brighter.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- shadowRecovery

		- is a value to control how much effect is wanted. The value can be between 0.0 and 1.0. Default is 0.0 (=disabled)

.. index:: pair: function; GetHighlightRecovery
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a2915fc1bfd4f8a21098e0adcfd0e3074:

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

	float GetHighlightRecovery() const

Get the value of the highight recovery setting in the convert config. See also SetHighlightRecovery function.

.. index:: pair: function; SetHighlightRecovery
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9fdfde92ae62ad048585a0759987cd4b:

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

	ConvertConfig SetHighlightRecovery(const float highlightRecovery)

Set highlight recovery. Used to extract details only in the highlights of the image by reducing the brightness of highlight pixels.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- shadowRecovery

		- is a value to control how much effect is wanted. The value can be between 0.0 and 1.0. Default is 0.0 (=disabled)

.. index:: pair: function; SetHistogramStage
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a370f3d227593e46b80d7ea2dc8df9fb0:

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

	ConvertConfig SetHistogramStage(const int stage)

Request in which stage of the processing pipeline a histogram must be sampled (its mainly used for debugging). Default is to not sample a histogram.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- stage

		- is a value defining the stage in processing where histogram is sampled

.. index:: pair: function; GetRedCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1af1dc005d47a6d51b9cb26f68d233e091:

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

	const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> GetRedCurve()

Get a vector of discreete coordinate pairs (x,y) describing the red curve used. See also SetRedCurve.

.. index:: pair: function; SetRedCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a18755e09386ef458324bfbbc60d4fdab:

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

	ConvertConfig SetRedCurve(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points)

Set the curve for red values as known from the curves tool in most image editors. The curve is defined as a vector of discreete coordinate pairs (x,y) that is interpolated. Default is a linear mapping: (0.0,0.0)-(1.0,1.0).



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- points

		- is a vector of discreete coordinate pairs (x,y) in the range (0.0,0.0)-(1.0,1.0).

.. index:: pair: function; GetGreenCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a0c213c95a6cf30c1601f924799838588:

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

	const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> GetGreenCurve()

Get a vector of discreete coordinate pairs (x,y) describing the green curve used. See also SetGreenCurve.

.. index:: pair: function; SetGreenCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a3bc0b00df7cfb23cf21d01fbfe1c11ba:

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

	ConvertConfig SetGreenCurve(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points)

Set the curve for green values as known from the curves tool in most image editors. The curve is defined as a vector of discreete coordinate pairs (x,y) that is interpolated. Default is a linear mapping: (0.0,0.0)-(1.0,1.0). It is similar to the curves tool known from most image editors.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- points

		- is a vector of discreete coordinate pairs (x,y) in the range (0.0,0.0)-(1.0,1.0).

.. index:: pair: function; GetBlueCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aed229c85cc4a2c35c8d6263aaf7d1c5d:

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

	const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> GetBlueCurve()

Get a vector of discreete coordinate pairs (x,y) describing the blue curve used. See also SetBlueCurve.

.. index:: pair: function; SetBlueCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a37758766609c78ac376d432f2c9c333e:

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

	ConvertConfig SetBlueCurve(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points)

Set the curve for blue values as known from the curves tool in most image editors. The curve is defined as a vector of discreete coordinate pairs (x,y) that is interpolated. Default is a linear mapping: (0.0,0.0)-(1.0,1.0). It is similar to the curves tool known from most image editors.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- points

		- is a vector of discreete coordinate pairs (x,y) in the range (0.0,0.0)-(1.0,1.0).

.. index:: pair: function; GetLumaCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5acaea1a8c4dc822898dcd302ba3ef2c:

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

	const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> GetLumaCurve()

Get a vector of discreete coordinate pairs (x,y) describing the luma curve used. See also SetLumaCurve.

.. index:: pair: function; SetLumaCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a18220c1f0d30b1578b0ce5cc442a0330:

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

	ConvertConfig SetLumaCurve(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points)

Set the curve for luma values as known from the curves tool in most image editors. The curve is defined as a vector of discreete coordinate pairs (x,y) that is interpolated. Default is a linear mapping: (0.0,0.0)-(1.0,1.0). It is similar to the curves tool known from most image editors.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- points

		- is a vector of discreete coordinate pairs (x,y) in the range (0.0,0.0)-(1.0,1.0).

.. index:: pair: function; GetRgbCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a676c025ddecc165bd39db1ba45e0ba1c:

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

	const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`> GetRgbCurve()

Get a vector of discreete coordinate pairs (x,y) describing the rgb curve used. See also SetLumaCurve.

.. index:: pair: function; SetRgbCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a874d52e089297808e34042357868b322:

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

	ConvertConfig SetRgbCurve(const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points)

Set the curve for rgb values as known from the curves tool in most image editors. The curve is defined as a vector of discreete coordinate pairs (x,y) that is interpolated. Default is a linear mapping: (0.0,0.0)-(1.0,1.0). It is similar to the curves tool known from most image editors.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- points

		- is a vector of discreete coordinate pairs (x,y) in the range (0.0,0.0)-(1.0,1.0).

.. index:: pair: function; GetWhiteBalanceGain
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab1e4cb56675342ea518e957a816dc99f:

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

	const :ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` GetWhiteBalanceGain() const

Returns the White Balance as gain for each channels (RGB)

.. index:: pair: function; SetWhiteBalanceGain
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a8cf48084e52091be32b169aebc5464b4:

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

	ConvertConfig SetWhiteBalanceGain(const :ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` whiteBalanceGain)

Sets the White Balance as gain for each channels (RGB)



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- whiteBalanceGain

		- is a :ref:`Color <doxid-union_p1_1_1_image_sdk_1_1_color>` with each field between 0.0f and 10.0f.

.. index:: pair: function; GetGeomerticCorrectionEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a5e5769bc6accbda71105ffff8c32528d:

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

	bool GetGeomerticCorrectionEnabled() const

Returns a Boolean value indicating if the conversion will include Geometric Aberration correction.

.. index:: pair: function; SetGeomerticCorrectionEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a76cfe16e3c284e73431d7ed1cb4b6a8d:

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

	ConvertConfig SetGeomerticCorrectionEnabled(const bool enable)

Sets the Enabled state of the Geometric Aberration correction.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- enable

		- true will enable Geometric Aberration correction, false will disable it.

.. index:: pair: function; GetGeometricCorrection
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a3bea5bf867fb2e17aa36f13476eff770:

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

	const :ref:`GeometricCorrection<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` GetGeometricCorrection() const

Custom Geometric Aberration correction parameters.

.. index:: pair: function; SetGeometricCorrection
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a99ac15ccb33d8653f74f4a487aa5a763:

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

	ConvertConfig SetGeometricCorrection(const :ref:`GeometricCorrection<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` geometricCorrection)

Sets Geometric Aberration correction parameters to be applied.

If geometricCorrection is set to an invalid value, the the conversion will try to load the geometric correction data embedded in the source IIQ file



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- geometricCorrection

		- the geometric correction to be used for the algorithm.

.. index:: pair: function; GetLightFalloffCorrectionEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ad7d7489a6cde1783ddcac248898a1dea:

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

	bool GetLightFalloffCorrectionEnabled() const

Returns a Boolean value indicating if the conversion will include Lens Light falloff correction for recognized lenses.

.. index:: pair: function; SetLightFalloffCorrectionEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a13dd650bad720dd5bbf847d7f27ba263:

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

	ConvertConfig SetLightFalloffCorrectionEnabled(const bool enable)

Sets the Enabled state of the Lens Light falloff correction.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- enable

		- true will enable Lens Light falloff correction, false will disable it.

.. index:: pair: function; GetChromaticAberrationCorrectionEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a431217649e66f7b810d9622c723db475:

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

	bool GetChromaticAberrationCorrectionEnabled() const

Returns a Boolean value indicating if the conversion will include Chromatic Aberration (CA) correction.

.. index:: pair: function; SetChromaticAberrationCorrectionEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ad0c9ebed28292025455922e5721331de:

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

	ConvertConfig SetChromaticAberrationCorrectionEnabled(const bool enable)

Sets the Enabled state of the Chromatic Aberration correction.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- enable

		- true will enable Chromatic Aberration correction, false will disable it.

.. index:: pair: function; GetExposureWarningMaskEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ab1d718c2b051e9feedb5a7c70a68c5ea:

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

	bool GetExposureWarningMaskEnabled() const

Threshold for under and over exposure mask.

.. index:: pair: function; SetExposureWarningMaskEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9028822ed944a65c42954df1ce212934:

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

	ConvertConfig SetExposureWarningMaskEnabled(const bool enable)

Control generation of exposure mask in the mask image. True means enable. Default is disabled. When doing the actual convertion of an image - a mask buffer must be provided. If enabled the underexposed threshold and overexposed threshold should also be set (See SetExposureMaskThreadhold function)

.. index:: pair: function; GetMaskThresholdOverExposure
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a687ec8d4a0c4c195d39dde00c2d4abb7:

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

	float GetMaskThresholdOverExposure()

Get the value of the overexposed setting used when exposure mask generation is enabled.

.. index:: pair: function; GetMaskThresholdUnderExposure
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a06f9a0dd79b649bb70811bd529f7bf68:

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

	float GetMaskThresholdUnderExposure()

Get the value of the underexposed setting used when exposure mask generation is enabled.

.. index:: pair: function; SetExposureMaskThreadhold
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a00a378b4e2f64e81905e27d8da1ef833:

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

	ConvertConfig SetExposureMaskThreadhold(
		float underExposeThreshold,
		float overExposeThreadhold
		)

Set the value of the overexposed and underexposed settings used when exposure mask generation is enabled.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- underExposeThreshold

		- is a value between 0.0 and 1.0 so it is independend of the bitdepth of the image

	*
		- overExposeThreshold

		- is a value between 0.0 and 1.0 so it is independend of the bitdepth of the image

.. index:: pair: function; GetClipWarningMaskEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a80dc121aa794a4ac6cb389099af3fba9:

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

	bool GetClipWarningMaskEnabled() const

Get the setting for clip warning mask enabled. See also SetClipWarningMaskEnabled and SetMaskThresholdClipWarningCount functions.

.. index:: pair: function; SetClipWarningMaskEnabled
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a9e1a4b7c810a1373a20d4076288c8d54:

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

	ConvertConfig SetClipWarningMaskEnabled(bool enable)

enable the clip warning mask. For this setting to be used the mask image must be enabled and provided when processing the image



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- enable.

		- can be true of false. false is the default value

.. index:: pair: function; GetMaskThresholdClipWarningCount
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aca458810eef1997c84a9cdb46ea41661:

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

	int GetMaskThresholdClipWarningCount()

Get the count of neighbour pixels that must be outside the threshold limits to be set in the clip warning mask.

.. index:: pair: function; SetMaskThresholdClipWarningCount
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a74bad099fce1518f6c426c0e030127e5:

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

	ConvertConfig SetMaskThresholdClipWarningCount(int thresholdCount)

Set the minimum required count of neighbour pixels that must be outside the threshold limits to be set in the clip warning mask. For this to take effect the mask image must be enabled .



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- thresholdCount

		- is a value between 1 and 8.

.. index:: pair: function; GetEnableLinearPath
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1ae1bfa4c30b82b8dcf25d28ff62c86d6f:

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

	bool GetEnableLinearPath() const

Get EnableLinearPath setting. See also description of SetEnableLinearPath.

.. index:: pair: function; SetEnableLinearPath
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a711a35a1ee66ee8013e0a0ebe38a6534:

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

	ConvertConfig SetEnableLinearPath(const bool enable)

Set EnableLinearPath setting. This setting is used to disable most of the processing steps to make sure that the debayering of the image into rgb domain is done only using a simple linear mapping enabling only the minimum needed processing.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- enable.

		- it can be set to true or false. False is the default value.

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

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

	:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` ApplyTo(
		const :ref:`RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& image,
		:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`* mask = nullptr,
		bool waitForBusySDK = true
		)

Apply your current configuration to a :ref:`RawImage <doxid-class_p1_1_1_image_sdk_1_1_raw_image>`.

.. index:: pair: function; SaveToFile
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1aa59eeede09e63c05694bf5edabc6ddd8:

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

	void SaveToFile(const char* filename) const

Store the configuration into a formatted file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- filename

		- the full path of the output

	*
		- Throws

		- an SDKException in case of failure (eg. failed to write to file)

.. index:: pair: function; Serialize
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a67784488e87a31e8b8993b5fae13166e:

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

	std::string Serialize() const

Converts the object into a JSON formatted string.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- Throws

		- an SDKException in case of failure (eg. failed to write to file)



.. rubric:: Returns:

A string which contains the JSON representation of the object

.. index:: pair: function; LoadFromFile
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a1298957c0219cee9859a3b05f6688c1e:

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

	static ConvertConfig LoadFromFile(const char* filename)

Creates a configuration from a formatted file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- filename

		- the full path of the input

	*
		- Throws

		- an SDKException in case of failure (eg. failed to read from file, the file was malformed)



.. rubric:: Returns:

A smart pointer to a newly created :ref:`ConvertConfig <doxid-class_p1_1_1_image_sdk_1_1_convert_config>` object

.. index:: pair: function; Deserialize
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1adc2b13765dd0403d4781fab6a5dfa015:

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

	static ConvertConfig Deserialize(const std::string serializedData)

Creates a configuration from a formatted JSON string.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- serializedData

		- a formatted JSON string

	*
		- Throws

		- an SDKException in case of failure (eg. the JSON string was malformed)



.. rubric:: Returns:

A smart pointer to a newly created :ref:`ConvertConfig <doxid-class_p1_1_1_image_sdk_1_1_convert_config>` object

.. index:: pair: function; DiscretizeCurve
.. _doxid-class_p1_1_1_image_sdk_1_1_convert_config_1a342076beaf3592814d66e4a143e4a791:

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

	static std::vector<float> DiscretizeCurve(
		const std::vector<:ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>`>& points,
		unsigned int bits
		)

Returns a list of 'Y' values of the Curve defined by the input Points. This is applicable for the RGB/LumaCurve)



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- points

		- the list of points defining the Curve, X and Y value must be in between 0 and 1

	*
		- bits

		- The resolution of the return value. Valid range: [0,12]

	*
		- Throws

		- an SDKException in case of failure (eg. input point list has less than two points)



.. rubric:: Returns:

A vector of the Y values of the evenly distributed between the two end points of the range [0, 1)