.. index:: pair: struct; P1::ImageSdk::GeometricCorrection
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction:

struct P1::ImageSdk::GeometricCorrection
========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

The collection of geometric correction parameters, as they are stated in Australis Format in the Calibration Result form received with calibrated cameras. :ref:`More...<details-struct_p1_1_1_image_sdk_1_1_geometric_correction>`


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

	#include <P1ImageLensDistortion.hpp>
	
	struct GeometricCorrection
	{
		// fields
	
		double :ref:`pixelSize<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a81607ff5d85b41b0cb2f760be466b783>` = -1.0;
		double :ref:`focalLength<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1ac56f1693b55b4be4c95e2d354d112557>` = -1.0;
		double :ref:`xp<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1ade7a2398584276b5cc39b3f426d64362>` = 0.0;
		double :ref:`yp<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1ae97fd11c942e19d7a87b3b612b128fb0>` = 0.0;
		double :ref:`k0<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a9831e3e5d9b7d33266152715dc6d0f3a>` = 1.0;
		double :ref:`k1<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a85a82c608614e5bdb5d8da2f33c0fbec>` = 0.0;
		double :ref:`k2<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a008d9e649f4efc4fe89bd7ea2e444f3f>` = 0.0;
		double :ref:`k3<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1af403aa4b5ece098255880d657cf90afa>` = 0.0;
		double :ref:`p1<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1abc0773919dd1dbccdbe113335766bdba>` = 0.0;
		double :ref:`p2<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1af76632accae76d753d19dc78ff45d6be>` = 0.0;
		double :ref:`b1<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a8ce64858c3ff52fad3bd4ec49a9b6826>` = 0.0;
		double :ref:`b2<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a21b49562ae23056264c6bc6ffba982a2>` = 0.0;
		int32_t :ref:`orientation<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1ae915823af07b714b799fb067eb650969>` = 0;

		// methods
	
		std::string :target:`ToString<doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a3ff055c15b4e06c5dc566256112a41cb>`() const;
	};
.. _details-struct_p1_1_1_image_sdk_1_1_geometric_correction:

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

The collection of geometric correction parameters, as they are stated in Australis Format in the Calibration Result form received with calibrated cameras.

Fields
------

.. index:: pair: variable; pixelSize
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a81607ff5d85b41b0cb2f760be466b783:

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

	double pixelSize = -1.0

Pixel size in mm.

.. index:: pair: variable; focalLength
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1ac56f1693b55b4be4c95e2d354d112557:

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

	double focalLength = -1.0

Lens focal lenght in mm.

.. index:: pair: variable; xp
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1ade7a2398584276b5cc39b3f426d64362:

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

	double xp = 0.0

Principal point offset x coordinate.

.. index:: pair: variable; yp
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1ae97fd11c942e19d7a87b3b612b128fb0:

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

	double yp = 0.0

Principal point offset y coordinate.

.. index:: pair: variable; k0
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a9831e3e5d9b7d33266152715dc6d0f3a:

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

	double k0 = 1.0

Zeroth radial distortion coefficient.

.. index:: pair: variable; k1
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a85a82c608614e5bdb5d8da2f33c0fbec:

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

	double k1 = 0.0

First radial distortion coefficient.

.. index:: pair: variable; k2
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a008d9e649f4efc4fe89bd7ea2e444f3f:

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

	double k2 = 0.0

Second radial distortion coefficient.

.. index:: pair: variable; k3
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1af403aa4b5ece098255880d657cf90afa:

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

	double k3 = 0.0

Third radial distortion coefficient.

.. index:: pair: variable; p1
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1abc0773919dd1dbccdbe113335766bdba:

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

	double p1 = 0.0

First radial-assymetric and tangential coefficient.

.. index:: pair: variable; p2
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1af76632accae76d753d19dc78ff45d6be:

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

	double p2 = 0.0

Second radial-assymetric and tangential coefficient.

.. index:: pair: variable; b1
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a8ce64858c3ff52fad3bd4ec49a9b6826:

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

	double b1 = 0.0

Affinity and non-orthogonality coefficient for x coordinate.

.. index:: pair: variable; b2
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1a21b49562ae23056264c6bc6ffba982a2:

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

	double b2 = 0.0

Affinity and non-orthogonality coefficient for y coordinate.

.. index:: pair: variable; orientation
.. _doxid-struct_p1_1_1_image_sdk_1_1_geometric_correction_1ae915823af07b714b799fb067eb650969:

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

	int32_t orientation = 0

The orientation of the calibration data in 90 degrees (valid values are [0, 90. 180, 270, -90].