.. index:: pair: class; P1::ImageSdk::RawImage
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image:

class P1::ImageSdk::RawImage
============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A handle to a Phase One IIQ image file, either on the file system or in a memory buffer :ref:`More...<details-class_p1_1_1_image_sdk_1_1_raw_image>`


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

	#include <P1ImageRawImage.hpp>
	
	class RawImage
	{
	public:
		// construction
	
		:ref:`RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a653374cfd767947d28145de3e133065e>`();
		:ref:`RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1abf6265d4c154b6b9495700c068909580>`(std::string iiqPath);
		:ref:`RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1ad5220f8aa3740eac4170034fff50ce52>`(std::shared_ptr<const uint8_t> buffer, uint32_t bufferByteSize);
		:target:`RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a28b833a8a8c87b22f8b28e44ba84b13a>`(const RawImage& other);

		// methods
	
		RawImage& :target:`operator =<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a8c1c300ec9b7a80b7b5ba61a4d31e5bb>` (const RawImage& other);
		uint32_t :ref:`Width<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a8286f4bb84fb35fa40404b8107c300da>`() const;
		uint32_t :ref:`Height<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a70bfc727d3b59aa28f0d1432e927ced9>`() const;
		uint32_t :ref:`RawSensorWidth<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a9ac416e60acb6a675f8a4b844747ef1f>`() const;
		uint32_t :ref:`RawSensorHeight<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a90ccd9ba5a686cc495138e22a1c2536d>`() const;
		:ref:`Size<doxid-struct_p1_1_1_image_sdk_1_1_size>` :ref:`GetDimensions<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a78e1102e55f5f76f4fb298711c8cff68>`() const;
		:ref:`ImageTag<doxid-class_p1_1_1_image_sdk_1_1_image_tag>` :ref:`GetTag<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a733c16a4d436b764798c9bbb577a871c>`(:ref:`TagId<doxid-struct_p1_1_1_image_sdk_1_1_tag_id>` id) const;
		bool :ref:`TagExists<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a8adfd2b147b728eabda998dc43e03383>`(:ref:`TagId<doxid-struct_p1_1_1_image_sdk_1_1_tag_id>` id) const;
		:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` :ref:`GetPreview<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a5248a96d0806d29c8a9d8e96a0733ffd>`(std::allocator<uint8_t> alloc = std::allocator<uint8_t>());
	
		:ref:`SensorBayerOutput<doxid-class_p1_1_1_image_sdk_1_1_sensor_bayer_output>` :ref:`Decode<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a1df2a7fa43626600041720319e83893c>`(
			const :ref:`DecodeConfig<doxid-class_p1_1_1_image_sdk_1_1_decode_config>`& config,
			std::allocator<uint8_t> alloc = std::allocator<uint8_t>(),
			bool waitWhenBusy = false
			) const;
	
		:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` :ref:`ProcessFromBuffer<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a662acbcc3976a961cf547fff6784b2fb>`(
			const :ref:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config>`& config,
			:ref:`SensorBayerOutput<doxid-class_p1_1_1_image_sdk_1_1_sensor_bayer_output>`* bayerBmp,
			std::allocator<uint8_t> alloc = std::allocator<uint8_t>(),
			:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`* maskImage = nullptr,
			bool waitWhenBusy = false
			) const;
	
		:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` :ref:`Convert<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a6a640a4136c0b8cd6bef6528c9c8de1d>`(
			const :ref:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config>`& config,
			std::allocator<uint8_t> alloc = std::allocator<uint8_t>(),
			:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`* maskImage = nullptr,
			bool waitWhenBusy = false
			) const;
	
		std::string :ref:`GetXmpPacket<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a4399d1f24cb76b895cebbdb2e992495d>`(std::allocator<char> alloc = std::allocator<char>()) const;
		:ref:`GpsData<doxid-struct_p1_1_1_image_sdk_1_1_gps_data>` :ref:`GetGpsData<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1ab8de599de7753885064aee3bf3e18838>`() const;
		int32_t :ref:`GetGpsEventId<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1ade03557dce1dd2304f78c64392bea05c>`() const;
		:ref:`ImuData<doxid-struct_p1_1_1_image_sdk_1_1_imu_data>` :ref:`GetImuData<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1addc760411264081163e1558da415cd27>`() const;
	
		:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` :ref:`PickWhiteBalance<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a04fa16528b277dd26dd960880c62bf1e>`(
			const :ref:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config>` config,
			const :ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>` point,
			int sampleSize
			) const;
	
		:ref:`Size<doxid-struct_p1_1_1_image_sdk_1_1_size>` :target:`GetCanvasSize<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1aaa51dc52d92c81fb3904504028563158>`(const :ref:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config>` config) const;
		:ref:`GeometricCorrection<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` :ref:`GetGeometricAberration<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a1993b06bbf6ab070366fd2f686ee3525>`() const;
		:ref:`GeometricCorrection<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction>` :target:`GetUserGeometricAberration<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a5c12831d01956d09849550ec6f72e71d>`() const;
		double :target:`GetNominalFocalLength<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a1843e9172716e104842be408bc011eb5>`() const;
		bool :target:`LoadUserCalibrationAndCompensationFromExternalFile<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a6231c9e19e5d0d9c911baae5563c5210>`(std::string filename);
		bool :target:`SetUserPressure<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a70e755c0d65799444b872c8685ac6b7d>`(float pressure);
		void :ref:`RequestHistogram<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a3c851ddf6e3539bf5279181c58888832>`(HistogramStage stage, int binSize = 512);
		void :ref:`RemoveHistogram<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1ae41adf0a5d64a1b0e5fd73aeab35a4df>`(HistogramStage stage);
	
		bool :ref:`GetHistogramStage<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a7a6bda9acf38dac328fac9b91764f382>`(
			:ref:`Histogram<doxid-class_p1_1_1_image_sdk_1_1_histogram>`* hist,
			HistogramStage stage,
			bool cummulative = false
			);
	
		bool :ref:`GetRawHistogram<doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a54d00d420400160731329829368a56b1>`(:ref:`Histogram<doxid-class_p1_1_1_image_sdk_1_1_histogram>`* hist);
	};
.. _details-class_p1_1_1_image_sdk_1_1_raw_image:

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

A handle to a Phase One IIQ image file, either on the file system or in a memory buffer

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

.. index:: pair: function; RawImage
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a653374cfd767947d28145de3e133065e:

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

	RawImage()

Constructs an empty and invalid :ref:`RawImage <doxid-class_p1_1_1_image_sdk_1_1_raw_image>` object.

.. index:: pair: function; RawImage
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1abf6265d4c154b6b9495700c068909580:

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

	RawImage(std::string iiqPath)

Construct a :ref:`RawImage <doxid-class_p1_1_1_image_sdk_1_1_raw_image>` from a file path.

.. index:: pair: function; RawImage
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1ad5220f8aa3740eac4170034fff50ce52:

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

	RawImage(std::shared_ptr<const uint8_t> buffer, uint32_t bufferByteSize)

Construct a :ref:`RawImage <doxid-class_p1_1_1_image_sdk_1_1_raw_image>` from a memory pointer, to a complete in-memory IIQ file.

Methods
-------

.. index:: pair: function; Width
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a8286f4bb84fb35fa40404b8107c300da:

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

	uint32_t Width() const

Get the image width, in pixels, of the exposed sensor area.

.. index:: pair: function; Height
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a70bfc727d3b59aa28f0d1432e927ced9:

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

	uint32_t Height() const

Get the image height, in pixels, of the exposed sensor area.

.. index:: pair: function; RawSensorWidth
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a9ac416e60acb6a675f8a4b844747ef1f:

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

	uint32_t RawSensorWidth() const

Get full width of the raw sensor output in pixels (including un-exposed area)

.. index:: pair: function; RawSensorHeight
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a90ccd9ba5a686cc495138e22a1c2536d:

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

	uint32_t RawSensorHeight() const

Get the full height of the raw sensor output in pixels (including un-exposed area)

.. index:: pair: function; GetDimensions
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a78e1102e55f5f76f4fb298711c8cff68:

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

	:ref:`Size<doxid-struct_p1_1_1_image_sdk_1_1_size>` GetDimensions() const

Get the image dimensions, in pixels, of the exposed sensor area.

.. index:: pair: function; GetTag
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a733c16a4d436b764798c9bbb577a871c:

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

	:ref:`ImageTag<doxid-class_p1_1_1_image_sdk_1_1_image_tag>` GetTag(:ref:`TagId<doxid-struct_p1_1_1_image_sdk_1_1_tag_id>` id) const

Extract and return meta data from the image container file (IIQ)

.. index:: pair: function; TagExists
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a8adfd2b147b728eabda998dc43e03383:

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

	bool TagExists(:ref:`TagId<doxid-struct_p1_1_1_image_sdk_1_1_tag_id>` id) const

Check if a certain meta data tag exists in the image file.

.. index:: pair: function; GetPreview
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a5248a96d0806d29c8a9d8e96a0733ffd:

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

	:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` GetPreview(std::allocator<uint8_t> alloc = std::allocator<uint8_t>())

Extract any RGB bitmap preview / thumbnail from meta data.

IIQ files might contain a preview of the full image. This method extracts that image.



.. rubric:: Parameters:

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

	*
		- alloc

		- An *optional* memory allocator. Default is standard C++ ``new``.

.. index:: pair: function; Decode
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a1df2a7fa43626600041720319e83893c:

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

	:ref:`SensorBayerOutput<doxid-class_p1_1_1_image_sdk_1_1_sensor_bayer_output>` Decode(
		const :ref:`DecodeConfig<doxid-class_p1_1_1_image_sdk_1_1_decode_config>`& config,
		std::allocator<uint8_t> alloc = std::allocator<uint8_t>(),
		bool waitWhenBusy = false
		) const

Extract the Bayer (i.e RAW) data from the IIQ container file.

This operation consist of a decompression stage and a calibration stage.



.. rubric:: Parameters:

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

	*
		- config

		- The configuration of the static calibration options to be applied the sensor output

	*
		- alloc

		- An *optional* memory allocator. Default is standard C++ ``new``.

	*
		- waitWhenBusy

		- [Deprecated: Must always be false] If true the function call will be blocked until the SDK is idle and able to accept the task. If it is false, it will throw an SDKException if the SDK is busy

.. index:: pair: function; ProcessFromBuffer
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a662acbcc3976a961cf547fff6784b2fb:

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

	:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` ProcessFromBuffer(
		const :ref:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config>`& config,
		:ref:`SensorBayerOutput<doxid-class_p1_1_1_image_sdk_1_1_sensor_bayer_output>`* bayerBmp,
		std::allocator<uint8_t> alloc = std::allocator<uint8_t>(),
		:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`* maskImage = nullptr,
		bool waitWhenBusy = false
		) const

De-mosaic (RAW convert) the Bayer data into an RGB bitmap image.

This operation consist of a decompression stage and a calibration stage.



.. rubric:: Parameters:

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

	*
		- config

		- The configuration of the static calibration options to be applied the sensor output

	*
		- bayerBmp

		- The image data in Bayer format

	*
		- alloc

		- An *optional* memory allocator. Default is standard C++ ``new``.

	*
		- maskImage

		- Optional buffer for masking (out)

	*
		- waitWhenBusy

		- [Deprecated: Must always be false] If true the function call will be blocked until the SDK is idle and able to accept the task. If it is false, it will throw an SDKException if the SDK is busy

.. index:: pair: function; Convert
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a6a640a4136c0b8cd6bef6528c9c8de1d:

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

	:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` Convert(
		const :ref:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config>`& config,
		std::allocator<uint8_t> alloc = std::allocator<uint8_t>(),
		:ref:`BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`* maskImage = nullptr,
		bool waitWhenBusy = false
		) const

Extract and de-mosaic (RAW convert) the Bayer data into an RGB bitmap image.

Use the :ref:`ConvertConfig <doxid-class_p1_1_1_image_sdk_1_1_convert_config>` to control cropping and scaling.



.. rubric:: Parameters:

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

	*
		- config

		- A configuration object specifying optional crop and scaling

	*
		- alloc

		- An *optional* memory allocator. Default is standard C++ ``new``.

	*
		- maskImage

		- Optional buffer for masking (out)

	*
		- waitWhenBusy

		- [Deprecated: Must always be false] If true the function call will be blocked until the SDK is idle and able to accept the task. If it is false, it will throw an SDKException if the SDK is busy

.. index:: pair: function; GetXmpPacket
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a4399d1f24cb76b895cebbdb2e992495d:

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

	std::string GetXmpPacket(std::allocator<char> alloc = std::allocator<char>()) const

Convenience method to get the XMP meta data.

This method equivalent to using :ref:`GetTag() <doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a733c16a4d436b764798c9bbb577a871c>` to get the XmpPacket tag, and trimming the output for extranous white space.



.. rubric:: Parameters:

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

	*
		- alloc

		- An *optional* memory allocator. Default is standard C++ ``new``.

.. index:: pair: function; GetGpsData
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1ab8de599de7753885064aee3bf3e18838:

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

	:ref:`GpsData<doxid-struct_p1_1_1_image_sdk_1_1_gps_data>` GetGpsData() const

Extract the GPS data embedded in the IIQ files XMP meta data section, if any.

This is a convenience method. It is equal to using the GetXmpPacket method and parsing the GPS data tags.

If no GPS data is embedded in the IIQ file, this method will throw!

.. index:: pair: function; GetGpsEventId
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1ade03557dce1dd2304f78c64392bea05c:

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

	int32_t GetGpsEventId() const

Get the GPS Event identifier (ID), if it exists for the IIQ file.

This is a convenience method. It is equal to using the GetXmpPacket method and parsing the GPSEventID tag.

If the IIQ file does not contain a GPSEventId, this method will throw!

.. index:: pair: function; GetImuData
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1addc760411264081163e1558da415cd27:

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

	:ref:`ImuData<doxid-struct_p1_1_1_image_sdk_1_1_imu_data>` GetImuData() const

Extract the IMU data embedded in the IIQ files XMP meta data section, if any.

This is a convenience method. It is equal to using the GetXmpPacket method and parsing the IMU data tags.

If no IMU data is embedded in the IIQ file, this method will throw!

.. index:: pair: function; PickWhiteBalance
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a04fa16528b277dd26dd960880c62bf1e:

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

	:ref:`Color<doxid-union_p1_1_1_image_sdk_1_1_color>` PickWhiteBalance(
		const :ref:`ConvertConfig<doxid-class_p1_1_1_image_sdk_1_1_convert_config>` config,
		const :ref:`Point2D<doxid-struct_p1_1_1_image_sdk_1_1_point2_d>` point,
		int sampleSize
		) const

Generates a white balance gain value from a :ref:`Point <doxid-struct_p1_1_1_image_sdk_1_1_point>` defined on the View.

The recommended way to use this function is to present an Image on Screen for the user to select the :ref:`Point <doxid-struct_p1_1_1_image_sdk_1_1_point>` to pick the WB from. Using a pointing device the user could select the :ref:`Point <doxid-struct_p1_1_1_image_sdk_1_1_point>` on that Image View. The coordinate system for that :ref:`Point <doxid-struct_p1_1_1_image_sdk_1_1_point>` should match the Image View's coordinate system, assuming the origin is the top left corner of that image. To be able to map that :ref:`Point <doxid-struct_p1_1_1_image_sdk_1_1_point>` on the image data, the input :ref:`ConvertConfig <doxid-class_p1_1_1_image_sdk_1_1_convert_config>` must have the exact same geometry defined (including Crop and Scaling). You can reuse the same :ref:`ConvertConfig <doxid-class_p1_1_1_image_sdk_1_1_convert_config>` used for the Image as it is not going to be modified. Average RGB gain is calculated from the area defined by sampleSize and used to calculate a white balance.



.. rubric:: Parameters:

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

	*
		- config

		- A :ref:`ConvertConfig <doxid-class_p1_1_1_image_sdk_1_1_convert_config>` object containing the Geometry transformation the view was based upon.

	*
		- point

		- The X,Y coordinates of the center of the sampled area based on the View Coordinate System

	*
		- sampleSize

		- A value between 1 and 10 that determines the size of the area to average. 1 is a single pixel area, 10 is 10x10 (100) pixels with x,y in the center



.. rubric:: Returns:

The white balance calculated based on the input. Note the alpha value of the :ref:`Color <doxid-union_p1_1_1_image_sdk_1_1_color>` is undefined

.. index:: pair: function; GetGeometricAberration
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a1993b06bbf6ab070366fd2f686ee3525:

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

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

Returns the geometric aberration information of the camera.



.. rubric:: Returns:

The Australis geometric aberration parameters embedded in the raw file

.. index:: pair: function; RequestHistogram
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a3c851ddf6e3539bf5279181c58888832:

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

	void RequestHistogram(HistogramStage stage, int binSize = 512)

Request ImageSDK to compute histogram at certain stage of the processing pipeline. Multiple stages can be requested.

.. index:: pair: function; RemoveHistogram
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1ae41adf0a5d64a1b0e5fd73aeab35a4df:

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

	void RemoveHistogram(HistogramStage stage)

Remove histogram at stage of the processing pipeline.

.. index:: pair: function; GetHistogramStage
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a7a6bda9acf38dac328fac9b91764f382:

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

	bool GetHistogramStage(
		:ref:`Histogram<doxid-class_p1_1_1_image_sdk_1_1_histogram>`* hist,
		HistogramStage stage,
		bool cummulative = false
		)

Get requested histogram at certain stage (Must be requested in advanced using :ref:`RequestHistogram() <doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a3c851ddf6e3539bf5279181c58888832>`)



.. rubric:: Returns:

:ref:`Histogram <doxid-class_p1_1_1_image_sdk_1_1_histogram>` at that stage.

.. index:: pair: function; GetRawHistogram
.. _doxid-class_p1_1_1_image_sdk_1_1_raw_image_1a54d00d420400160731329829368a56b1:

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

	bool GetRawHistogram(:ref:`Histogram<doxid-class_p1_1_1_image_sdk_1_1_histogram>`* hist)

Get histogram embedded in IIQ file.



.. rubric:: Returns:

:ref:`Histogram <doxid-class_p1_1_1_image_sdk_1_1_histogram>` at that stage.