.. index:: pair: class; P1::ImageSdk::Stitching
.. _doxid-class_p1_1_1_image_sdk_1_1_stitching:

class P1::ImageSdk::Stitching
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <P1ImageStitching.hpp>
	
	class Stitching
	{
	public:
		// methods
	
		:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` :ref:`DoStitching<doxid-class_p1_1_1_image_sdk_1_1_stitching_1a2f2d905a74a188ac536f7f614b4b2a06>`(
			:ref:`P1::ImageSdk::RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& leftImage,
			:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`& leftBitmap,
			:ref:`P1::ImageSdk::RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& rightImage,
			:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`& rightBitmap,
			std::allocator<uint8_t> alloc = std::allocator<uint8_t>()
			);
	
		void :ref:`SetFineCalibration<doxid-class_p1_1_1_image_sdk_1_1_stitching_1aebbdac360afca4bfbdde7ce51e334bcd>`(
			uint8_t* fineCalibrationData,
			uint32_t fineCalibrationLength
			);
	
		uint8_t* :ref:`GetFineCalibrationData<doxid-class_p1_1_1_image_sdk_1_1_stitching_1abb8552d0baa5ebab967be37a0917ce25>`();
		uint32_t :ref:`GetFineCalibrationLength<doxid-class_p1_1_1_image_sdk_1_1_stitching_1ada89fb993d965ddcf63edbc81c1ac76f>`();
		:ref:`StitcherResult<doxid-namespace_p1_1_1_image_sdk_1a463f5745b257b52c06779cde1c46a4c4>` :ref:`GetLastResult<doxid-class_p1_1_1_image_sdk_1_1_stitching_1a54b4d0a64d605b9fcfb69619d3e3054c>`();
	};
.. _details-class_p1_1_1_image_sdk_1_1_stitching:

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



Methods
-------

.. index:: pair: function; DoStitching
.. _doxid-class_p1_1_1_image_sdk_1_1_stitching_1a2f2d905a74a188ac536f7f614b4b2a06:

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

	:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>` DoStitching(
		:ref:`P1::ImageSdk::RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& leftImage,
		:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`& leftBitmap,
		:ref:`P1::ImageSdk::RawImage<doxid-class_p1_1_1_image_sdk_1_1_raw_image>`& rightImage,
		:ref:`P1::ImageSdk::BitmapImage<doxid-class_p1_1_1_image_sdk_1_1_bitmap_image>`& rightBitmap,
		std::allocator<uint8_t> alloc = std::allocator<uint8_t>()
		)

A class to stitch L and R images from a PAS280 camera. The left image is regarded as the master image. The stitcher will seamlessly merge togther the two images into one large image.



.. rubric:: Parameters:

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

	*
		- leftImage

		- is a reference to the left image (containing metadata etc.)

	*
		- leftBitmap

		- is a reference to a bitmap of the left image

	*
		- rightImage

		- is a reference to the right image (containing metadata etc.)

	*
		- rightBitmap

		- is a reference to a bitmap of the right image

	*
		- alloc

		- is an allocator that is used to allocate memory for the output bitmap. Its an optional parameter and should not be used unless its important for the host program.

	*
		- throws

		- an :ref:`SdkException <doxid-class_p1_1_1_image_sdk_1_1_sdk_exception>` on errors



.. rubric:: Returns:

A bitmap containing the stitched image. The memory for the bitmap is allocated by the allocator and must be freed by the host software when not needed.

.. index:: pair: function; SetFineCalibration
.. _doxid-class_p1_1_1_image_sdk_1_1_stitching_1aebbdac360afca4bfbdde7ce51e334bcd:

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

	void SetFineCalibration(
		uint8_t* fineCalibrationData,
		uint32_t fineCalibrationLength
		)

Setup a fine calibration. A finecalibration is a binary blob setup by the stitcher itself that can speed up the stitching process.



.. rubric:: Parameters:

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

	*
		- fineCalibrationData

		- is a pointer to the data where the fine calibration to setup is stored.

	*
		- fineCalibrationLength

		- is an integer that tells how much memory the finecalibration is using

.. index:: pair: function; GetFineCalibrationData
.. _doxid-class_p1_1_1_image_sdk_1_1_stitching_1abb8552d0baa5ebab967be37a0917ce25:

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

	uint8_t* GetFineCalibrationData()

Get a pointer to the fine calibration data from the stitcher.

.. index:: pair: function; GetFineCalibrationLength
.. _doxid-class_p1_1_1_image_sdk_1_1_stitching_1ada89fb993d965ddcf63edbc81c1ac76f:

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

	uint32_t GetFineCalibrationLength()

Get an integer with the length of the fine calibration data in the stitcher.

.. index:: pair: function; GetLastResult
.. _doxid-class_p1_1_1_image_sdk_1_1_stitching_1a54b4d0a64d605b9fcfb69619d3e3054c:

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

	:ref:`StitcherResult<doxid-namespace_p1_1_1_image_sdk_1a463f5745b257b52c06779cde1c46a4c4>` GetLastResult()

Get the last result of the stitcher. This can be used to get info about errors and warnings that had an impact on the stitching. Errors will cause the stitcher to throw an excetion.