3D vision functionality#

Detailed Description#

Most of the functions in this section use a so-called pinhole camera model. The view of a scene is obtained by projecting a scene’s 3D point \(P_w\) into the image plane using a perspective transformation which forms the corresponding pixel \(p\). Both \(P_w\) and \(p\) are represented in homogeneous coordinates, i.e. as 3D and 2D homogeneous vector respectively. You will find a brief introduction to projective geometry, homogeneous vectors and homogeneous transformations at the end of this section’s introduction. For more succinct notation, we often drop the ‘homogeneous’ and say vector instead of homogeneous vector.

The distortion-free projective transformation given by a pinhole camera model is shown below.

\[ s \; p = A \begin{bmatrix} R|t \end{bmatrix} P_w, \]

where \(P_w\) is a 3D point expressed with respect to the world coordinate system, \(p\) is a 2D pixel in the image plane, \(A\) is the camera intrinsic matrix, \(R\) and \(t\) are the rotation and translation that describe the change of coordinates from world to camera coordinate systems (or camera frame) and \(s\) is the projective transformation’s arbitrary scaling and not part of the camera model.

The camera intrinsic matrix \(A\) (notation used as in [353] and also generally notated as \(K\)) projects 3D points given in the camera coordinate system to 2D pixel coordinates, i.e.

\[ p = A P_c. \]

The camera intrinsic matrix \(A\) is composed of the focal lengths \(f_x\) and \(f_y\), which are expressed in pixel units, and the principal point \((c_x, c_y)\), that is usually close to the image center:

\[ A = \vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}, \]

and thus

\[ s \vecthree{u}{v}{1} = \vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1} \vecthree{X_c}{Y_c}{Z_c}. \]

The matrix of intrinsic parameters does not depend on the scene viewed. So, once estimated, it can be re-used as long as the focal length is fixed (in case of a zoom lens). Thus, if an image from the camera is scaled by a factor, all of these parameters need to be scaled (multiplied/divided, respectively) by the same factor.

The joint rotation-translation matrix \([R|t]\) is the matrix product of a projective transformation and a homogeneous transformation. The 3-by-4 projective transformation maps 3D points represented in camera coordinates to 2D points in the image plane and represented in normalized camera coordinates \(x' = X_c / Z_c\) and \(y' = Y_c / Z_c\):

\[\begin{split} Z_c \begin{bmatrix} x' \\ y' \\ 1 \end{bmatrix} = \begin{bmatrix} 1 & 0 & 0 & 0 \\ 0 & 1 & 0 & 0 \\ 0 & 0 & 1 & 0 \end{bmatrix} \begin{bmatrix} X_c \\ Y_c \\ Z_c \\ 1 \end{bmatrix}. \end{split}\]

The homogeneous transformation is encoded by the extrinsic parameters \(R\) and \(t\) and represents the change of basis from world coordinate system \(w\) to the camera coordinate sytem \(c\). Thus, given the representation of the point \(P\) in world coordinates, \(P_w\), we obtain \(P\)’s representation in the camera coordinate system, \(P_c\), by

\[\begin{split} P_c = \begin{bmatrix} R & t \\ 0 & 1 \end{bmatrix} P_w, \end{split}\]

This homogeneous transformation is composed out of \(R\), a 3-by-3 rotation matrix, and \(t\), a 3-by-1 translation vector:

\[\begin{split} \begin{bmatrix} R & t \\ 0 & 1 \end{bmatrix} = \begin{bmatrix} r_{11} & r_{12} & r_{13} & t_x \\ r_{21} & r_{22} & r_{23} & t_y \\ r_{31} & r_{32} & r_{33} & t_z \\ 0 & 0 & 0 & 1 \end{bmatrix}, \end{split}\]

and therefore

\[\begin{split} \begin{bmatrix} X_c \\ Y_c \\ Z_c \\ 1 \end{bmatrix} = \begin{bmatrix} r_{11} & r_{12} & r_{13} & t_x \\ r_{21} & r_{22} & r_{23} & t_y \\ r_{31} & r_{32} & r_{33} & t_z \\ 0 & 0 & 0 & 1 \end{bmatrix} \begin{bmatrix} X_w \\ Y_w \\ Z_w \\ 1 \end{bmatrix}. \end{split}\]

Combining the projective transformation and the homogeneous transformation, we obtain the projective transformation that maps 3D points in world coordinates into 2D points in the image plane and in normalized camera coordinates:

\[\begin{split} Z_c \begin{bmatrix} x' \\ y' \\ 1 \end{bmatrix} = \begin{bmatrix} R|t \end{bmatrix} \begin{bmatrix} X_w \\ Y_w \\ Z_w \\ 1 \end{bmatrix} = \begin{bmatrix} r_{11} & r_{12} & r_{13} & t_x \\ r_{21} & r_{22} & r_{23} & t_y \\ r_{31} & r_{32} & r_{33} & t_z \end{bmatrix} \begin{bmatrix} X_w \\ Y_w \\ Z_w \\ 1 \end{bmatrix}, \end{split}\]

with \(x' = X_c / Z_c\) and \(y' = Y_c / Z_c\). Putting the equations for instrincs and extrinsics together, we can write out \(s \; p = A \begin{bmatrix} R|t \end{bmatrix} P_w\) as

\[\begin{split} s \vecthree{u}{v}{1} = \vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1} \begin{bmatrix} r_{11} & r_{12} & r_{13} & t_x \\ r_{21} & r_{22} & r_{23} & t_y \\ r_{31} & r_{32} & r_{33} & t_z \end{bmatrix} \begin{bmatrix} X_w \\ Y_w \\ Z_w \\ 1 \end{bmatrix}. \end{split}\]

If \(Z_c \ne 0\), the transformation above is equivalent to the following,

\[\begin{split} \begin{bmatrix} u \\ v \end{bmatrix} = \begin{bmatrix} f_x X_c/Z_c + c_x \\ f_y Y_c/Z_c + c_y \end{bmatrix} \end{split}\]

with

\[\begin{split} \vecthree{X_c}{Y_c}{Z_c} = \begin{bmatrix} R|t \end{bmatrix} \begin{bmatrix} X_w \\ Y_w \\ Z_w \\ 1 \end{bmatrix}. \end{split}\]

The following figure illustrates the pinhole camera model.

Pinhole camera model

Real lenses usually have some distortion, mostly radial distortion, and slight tangential distortion. So, the above model is extended as:

\[\begin{split} \begin{bmatrix} u \\ v \end{bmatrix} = \begin{bmatrix} f_x x'' + c_x \\ f_y y'' + c_y \end{bmatrix} \end{split}\]

where

\[\begin{split} \begin{bmatrix} x'' \\ y'' \end{bmatrix} = \begin{bmatrix} x' \frac{1 + k_1 r^2 + k_2 r^4 + k_3 r^6}{1 + k_4 r^2 + k_5 r^4 + k_6 r^6} + 2 p_1 x' y' + p_2(r^2 + 2 x'^2) + s_1 r^2 + s_2 r^4 \\ y' \frac{1 + k_1 r^2 + k_2 r^4 + k_3 r^6}{1 + k_4 r^2 + k_5 r^4 + k_6 r^6} + p_1 (r^2 + 2 y'^2) + 2 p_2 x' y' + s_3 r^2 + s_4 r^4 \\ \end{bmatrix} \end{split}\]

with

\[ r^2 = x'^2 + y'^2 \]

and

\[\begin{split} \begin{bmatrix} x'\\ y' \end{bmatrix} = \begin{bmatrix} X_c/Z_c \\ Y_c/Z_c \end{bmatrix}, \end{split}\]

if \(Z_c \ne 0\).

The distortion parameters are the radial coefficients \(k_1\), \(k_2\), \(k_3\), \(k_4\), \(k_5\), and \(k_6\) , \(p_1\) and \(p_2\) are the tangential distortion coefficients, and \(s_1\), \(s_2\), \(s_3\), and \(s_4\), are the thin prism distortion coefficients. Higher-order coefficients are not considered in OpenCV.

The next figures show two common types of radial distortion: barrel distortion ( \( 1 + k_1 r^2 + k_2 r^4 + k_3 r^6 \) monotonically decreasing) and pincushion distortion ( \( 1 + k_1 r^2 + k_2 r^4 + k_3 r^6 \) monotonically increasing). Radial distortion is always monotonic for real lenses, and if the estimator produces a non-monotonic result, this should be considered a calibration failure. More generally, radial distortion must be monotonic and the distortion function must be bijective. A failed estimation result may look deceptively good near the image center but will work poorly in e.g. AR/SFM applications. The optimization method used in OpenCV camera calibration does not include these constraints as the framework does not support the required integer programming and polynomial inequalities. See issue #15992 for additional information.

In some cases, the image sensor may be tilted in order to focus an oblique plane in front of the camera (Scheimpflug principle). This can be useful for particle image velocimetry (PIV) or triangulation with a laser fan. The tilt causes a perspective distortion of \(x''\) and \(y''\). This distortion can be modeled in the following way, see e.g. [191].

\[\begin{split} \begin{bmatrix} u \\ v \end{bmatrix} = \begin{bmatrix} f_x x''' + c_x \\ f_y y''' + c_y \end{bmatrix}, \end{split}\]

where

\[ s\vecthree{x'''}{y'''}{1} = \vecthreethree{R_{33}(\tau_x, \tau_y)}{0}{-R_{13}(\tau_x, \tau_y)} {0}{R_{33}(\tau_x, \tau_y)}{-R_{23}(\tau_x, \tau_y)} {0}{0}{1} R(\tau_x, \tau_y) \vecthree{x''}{y''}{1} \]

and the matrix \(R(\tau_x, \tau_y)\) is defined by two rotations with angular parameter \(\tau_x\) and \(\tau_y\), respectively,

\[ R(\tau_x, \tau_y) = \vecthreethree{\cos(\tau_y)}{0}{-\sin(\tau_y)}{0}{1}{0}{\sin(\tau_y)}{0}{\cos(\tau_y)} \vecthreethree{1}{0}{0}{0}{\cos(\tau_x)}{\sin(\tau_x)}{0}{-\sin(\tau_x)}{\cos(\tau_x)} = \vecthreethree{\cos(\tau_y)}{\sin(\tau_y)\sin(\tau_x)}{-\sin(\tau_y)\cos(\tau_x)} {0}{\cos(\tau_x)}{\sin(\tau_x)} {\sin(\tau_y)}{-\cos(\tau_y)\sin(\tau_x)}{\cos(\tau_y)\cos(\tau_x)}. \]

In the functions below the coefficients are passed or returned as

\[ (k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \tau_x, \tau_y]]]]) \]

vector. That is, if the vector contains four elements, it means that \(k_3=0\) . The distortion coefficients do not depend on the scene viewed. Thus, they also belong to the intrinsic camera parameters. And they remain the same regardless of the captured image resolution. If, for example, a camera has been calibrated on images of 320 x 240 resolution, absolutely the same distortion coefficients can be used for 640 x 480 images from the same camera while \(f_x\), \(f_y\), \(c_x\), and \(c_y\) need to be scaled appropriately.

The functions below use the above model to do the following:

  • Project 3D points to the image plane given intrinsic and extrinsic parameters.

  • Compute extrinsic parameters given intrinsic parameters, a few 3D points, and their projections.

  • Estimate intrinsic and extrinsic camera parameters from several views of a known calibration pattern (every view is described by several 3D-2D point correspondences).

  • Estimate the relative position and orientation of the stereo camera “heads” and compute the rectification* transformation that makes the camera optical axes parallel.

Homogeneous Coordinates

Homogeneous Coordinates are a system of coordinates that are used in projective geometry. Their use allows to represent points at infinity by finite coordinates and simplifies formulas when compared to the cartesian counterparts, e.g. they have the advantage that affine transformations can be expressed as linear homogeneous transformation.

One obtains the homogeneous vector \(P_h\) by appending a 1 along an n-dimensional cartesian vector \(P\) e.g. for a 3D cartesian vector the mapping \(P \rightarrow P_h\) is:

\[\begin{split} \begin{bmatrix} X \\ Y \\ Z \end{bmatrix} \rightarrow \begin{bmatrix} X \\ Y \\ Z \\ 1 \end{bmatrix}. \end{split}\]

For the inverse mapping \(P_h \rightarrow P\), one divides all elements of the homogeneous vector by its last element, e.g. for a 3D homogeneous vector one gets its 2D cartesian counterpart by:

\[\begin{split} \begin{bmatrix} X \\ Y \\ W \end{bmatrix} \rightarrow \begin{bmatrix} X / W \\ Y / W \end{bmatrix}, \end{split}\]

if \(W \ne 0\).

Due to this mapping, all multiples \(k P_h\), for \(k \ne 0\), of a homogeneous point represent the same point \(P_h\). An intuitive understanding of this property is that under a projective transformation, all multiples of \(P_h\) are mapped to the same point. This is the physical observation one does for pinhole cameras, as all points along a ray through the camera’s pinhole are projected to the same image point, e.g. all points along the red ray in the image of the pinhole camera model above would be mapped to the same image coordinate. This property is also the source for the scale ambiguity s in the equation of the pinhole camera model.

As mentioned, by using homogeneous coordinates we can express any change of basis parameterized by \(R\) and \(t\) as a linear transformation, e.g. for the change of basis from coordinate system 0 to coordinate system 1 becomes:

\[\begin{split} P_1 = R P_0 + t \rightarrow P_{h_1} = \begin{bmatrix} R & t \\ 0 & 1 \end{bmatrix} P_{h_0}. \end{split}\]

Note

Namespaces#

Classes#

Name

Description

class cv::LevMarq

Levenberg-Marquadt solver. View details

struct cv::UsacParams

View details

Enumerations#

enum cv {
    LMEDS = 4,
    RANSAC = 8,
    RHO = 16,
    USAC_DEFAULT = 32,
    USAC_PARALLEL = 33,
    USAC_FM_8PTS = 34,
    USAC_FAST = 35,
    USAC_ACCURATE = 36,
    USAC_PROSAC = 37,
    USAC_MAGSAC = 38
}

type of the robust estimation algorithm View details

enum cv {
    FM_7POINT = 1,
    FM_8POINT = 2,
    FM_LMEDS = 4,
    FM_RANSAC = 8
}

the algorithm for finding fundamental matrix View details

View details

Type of matrix used in LevMarq solver. View details

View details

View details

View details

View details

View details

Type of variables used in LevMarq solver. View details

Enumeration Type Documentation#

enum#

#include <opencv2/geometry/3d.hpp>

type of the robust estimation algorithm

Enumerator:

LMEDS

least-median of squares algorithm

RANSAC

RANSAC algorithm.

RHO

RHO algorithm.

USAC_DEFAULT

USAC algorithm, default settings.

USAC_PARALLEL

USAC, parallel version.

USAC_FM_8PTS

USAC, fundamental matrix 8 points.

USAC_FAST

USAC, fast settings.

USAC_ACCURATE

USAC, accurate settings.

USAC_PROSAC

USAC, sorted points, runs PROSAC.

USAC_MAGSAC

USAC, runs MAGSAC++.

enum#

#include <opencv2/geometry/3d.hpp>

the algorithm for finding fundamental matrix

Enumerator:

FM_7POINT

7-point algorithm

FM_8POINT

8-point algorithm

FM_LMEDS

least-median algorithm. 7-point algorithm is used.

FM_RANSAC

RANSAC algorithm. It needs at least 15 points. 7-point algorithm is used.

LocalOptimMethod#

enum cv::LocalOptimMethod

#include <opencv2/geometry/3d.hpp>

Enumerator:

LOCAL_OPTIM_NULL
Python: cv.LOCAL_OPTIM_NULL

LOCAL_OPTIM_INNER_LO
Python: cv.LOCAL_OPTIM_INNER_LO

LOCAL_OPTIM_INNER_AND_ITER_LO
Python: cv.LOCAL_OPTIM_INNER_AND_ITER_LO

LOCAL_OPTIM_GC
Python: cv.LOCAL_OPTIM_GC

LOCAL_OPTIM_SIGMA
Python: cv.LOCAL_OPTIM_SIGMA

MatrixType#

enum class cv::MatrixType

#include <opencv2/geometry/3d.hpp>

Type of matrix used in LevMarq solver.

Matrix type can be dense, sparse or chosen automatically based on a matrix size, performance considerations or backend availability.

Note: only dense matrix is now supported

Enumerator:

AUTO
Python: cv.MatrixType_AUTO

DENSE
Python: cv.MatrixType_DENSE

SPARSE
Python: cv.MatrixType_SPARSE

NeighborSearchMethod#

enum cv::NeighborSearchMethod

#include <opencv2/geometry/3d.hpp>

Enumerator:

NEIGH_FLANN_KNN
Python: cv.NEIGH_FLANN_KNN

NEIGH_GRID
Python: cv.NEIGH_GRID

NEIGH_FLANN_RADIUS
Python: cv.NEIGH_FLANN_RADIUS

PolishingMethod#

enum cv::PolishingMethod

#include <opencv2/geometry/3d.hpp>

Enumerator:

NONE_POLISHER
Python: cv.NONE_POLISHER

LSQ_POLISHER
Python: cv.LSQ_POLISHER

MAGSAC
Python: cv.MAGSAC

COV_POLISHER
Python: cv.COV_POLISHER

SamplingMethod#

enum cv::SamplingMethod

#include <opencv2/geometry/3d.hpp>

Enumerator:

SAMPLING_UNIFORM
Python: cv.SAMPLING_UNIFORM

SAMPLING_PROGRESSIVE_NAPSAC
Python: cv.SAMPLING_PROGRESSIVE_NAPSAC

SAMPLING_NAPSAC
Python: cv.SAMPLING_NAPSAC

SAMPLING_PROSAC
Python: cv.SAMPLING_PROSAC

ScoreMethod#

enum cv::ScoreMethod

#include <opencv2/geometry/3d.hpp>

Enumerator:

SCORE_METHOD_RANSAC
Python: cv.SCORE_METHOD_RANSAC

SCORE_METHOD_MSAC
Python: cv.SCORE_METHOD_MSAC

SCORE_METHOD_MAGSAC
Python: cv.SCORE_METHOD_MAGSAC

SCORE_METHOD_LMEDS
Python: cv.SCORE_METHOD_LMEDS

SolvePnPMethod#

enum cv::SolvePnPMethod

#include <opencv2/geometry/3d.hpp>

Enumerator:

SOLVEPNP_ITERATIVE
Python: cv.SOLVEPNP_ITERATIVE

Pose refinement using non-linear Levenberg-Marquardt minimization scheme [200] [88]

Initial solution for non-planar “objectPoints” needs at least 6 points and uses the DLT algorithm.

Initial solution for planar “objectPoints” needs at least 4 points and uses pose from homography decomposition.

SOLVEPNP_EPNP
Python: cv.SOLVEPNP_EPNP

EPnP: Efficient Perspective-n-Point Camera Pose Estimation [176].

SOLVEPNP_P3P
Python: cv.SOLVEPNP_P3P

Revisiting the P3P Problem [79].

SOLVEPNP_AP3P
Python: cv.SOLVEPNP_AP3P

An Efficient Algebraic Solution to the Perspective-Three-Point Problem [163].

SOLVEPNP_IPPE
Python: cv.SOLVEPNP_IPPE

Infinitesimal Plane-Based Pose Estimation [69]

Object points must be coplanar.

SOLVEPNP_IPPE_SQUARE
Python: cv.SOLVEPNP_IPPE_SQUARE

Infinitesimal Plane-Based Pose Estimation [69]

This is a special case suitable for marker pose estimation.

4 coplanar object points must be defined in the following order:

  • point 0: [-squareLength / 2, squareLength / 2, 0]

  • point 1: [ squareLength / 2, squareLength / 2, 0]

  • point 2: [ squareLength / 2, -squareLength / 2, 0]

  • point 3: [-squareLength / 2, -squareLength / 2, 0]

SOLVEPNP_SQPNP
Python: cv.SOLVEPNP_SQPNP

SQPnP: A Consistently Fast and Globally OptimalSolution to the Perspective-n-Point Problem [302].

VariableType#

enum class cv::VariableType

#include <opencv2/geometry/3d.hpp>

Type of variables used in LevMarq solver.

Variables can be linear, rotation (SO(3) group) or rigid transformation (SE(3) group) with corresponding jacobians and exponential updates.

Note: only linear variables are now supported

Enumerator:

LINEAR
Python: cv.VariableType_LINEAR

SO3
Python: cv.VariableType_SO3

SE3
Python: cv.VariableType_SE3

Function Documentation#

calibrationMatrixValues()#

void cv::calibrationMatrixValues(
InputArray cameraMatrix,
Size imageSize,
double apertureWidth,
double apertureHeight,
double & fovx,
double & fovy,
double & focalLength,
Point2d & principalPoint,
double & aspectRatio )

#include <opencv2/geometry/3d.hpp>

Python:

cv.calibrationMatrixValues(cameraMatrix, imageSize, apertureWidth, apertureHeight) -> fovx, fovy, focalLength, principalPoint, aspectRatio

Computes useful camera characteristics from the camera intrinsic matrix.

The function computes various useful camera characteristics from the previously estimated camera matrix.

Note

Do keep in mind that the unity measure ‘mm’ stands for whatever unit of measure one chooses for the chessboard pitch (it can thus be any value).

Parameters

  • cameraMatrix — Input camera intrinsic matrix that can be estimated by calibrateCamera or stereoCalibrate .

  • imageSize — Input image size in pixels.

  • apertureWidth — Physical width in mm of the sensor.

  • apertureHeight — Physical height in mm of the sensor.

  • fovx — Output field of view in degrees along the horizontal sensor axis.

  • fovy — Output field of view in degrees along the vertical sensor axis.

  • focalLength — Focal length of the lens in mm.

  • principalPoint — Principal point in mm.

  • aspectRatio\(f_y/f_x\)

composeRT()#

void cv::composeRT(
InputArray rvec1,
InputArray tvec1,
InputArray rvec2,
InputArray tvec2,
OutputArray rvec3,
OutputArray tvec3,
OutputArray dr3dr1 = noArray(),
OutputArray dr3dt1 = noArray(),
OutputArray dr3dr2 = noArray(),
OutputArray dr3dt2 = noArray(),
OutputArray dt3dr1 = noArray(),
OutputArray dt3dt1 = noArray(),
OutputArray dt3dr2 = noArray(),
OutputArray dt3dt2 = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.composeRT(rvec1, tvec1, rvec2, tvec2[, rvec3[, tvec3[, dr3dr1[, dr3dt1[, dr3dr2[, dr3dt2[, dt3dr1[, dt3dt1[, dt3dr2[, dt3dt2]]]]]]]]]]) -> rvec3, tvec3, dr3dr1, dr3dt1, dr3dr2, dr3dt2, dt3dr1, dt3dt1, dt3dr2, dt3dt2

Combines two rotation-and-shift transformations.

The functions compute:

\[\begin{split} \begin{array}{l} \texttt{rvec3} = \mathrm{rodrigues} ^{-1} \left ( \mathrm{rodrigues} ( \texttt{rvec2} ) \cdot \mathrm{rodrigues} ( \texttt{rvec1} ) \right ) \\ \texttt{tvec3} = \mathrm{rodrigues} ( \texttt{rvec2} ) \cdot \texttt{tvec1} + \texttt{tvec2} \end{array} , \end{split}\]

where \(\mathrm{rodrigues}\) denotes a rotation vector to a rotation matrix transformation, and \(\mathrm{rodrigues}^{-1}\) denotes the inverse transformation. See Rodrigues for details.

Also, the functions can compute the derivatives of the output vectors with regards to the input vectors (see matMulDeriv ). The functions are used inside stereoCalibrate but can also be used in your own code where Levenberg-Marquardt or another gradient-based solver is used to optimize a function that contains a matrix multiplication.

Parameters

  • rvec1 — First rotation vector.

  • tvec1 — First translation vector.

  • rvec2 — Second rotation vector.

  • tvec2 — Second translation vector.

  • rvec3 — Output rotation vector of the superposition.

  • tvec3 — Output translation vector of the superposition.

  • dr3dr1 — Optional output derivative of rvec3 with regard to rvec1

  • dr3dt1 — Optional output derivative of rvec3 with regard to tvec1

  • dr3dr2 — Optional output derivative of rvec3 with regard to rvec2

  • dr3dt2 — Optional output derivative of rvec3 with regard to tvec2

  • dt3dr1 — Optional output derivative of tvec3 with regard to rvec1

  • dt3dt1 — Optional output derivative of tvec3 with regard to tvec1

  • dt3dr2 — Optional output derivative of tvec3 with regard to rvec2

  • dt3dt2 — Optional output derivative of tvec3 with regard to tvec2

computeCorrespondEpilines()#

void cv::computeCorrespondEpilines(
InputArray points,
int whichImage,
InputArray F,
OutputArray lines )

#include <opencv2/geometry/3d.hpp>

Python:

cv.computeCorrespondEpilines(points, whichImage, F[, lines]) -> lines

For points in an image of a stereo pair, computes the corresponding epilines in the other image.

For every point in one of the two images of a stereo pair, the function finds the equation of the corresponding epipolar line in the other image.

From the fundamental matrix definition (see findFundamentalMat ), line \(l^{(2)}_i\) in the second image for the point \(p^{(1)}_i\) in the first image (when whichImage=1 ) is computed as:

\[ l^{(2)}_i = F p^{(1)}_i \]

And vice versa, when whichImage=2, \(l^{(1)}_i\) is computed from \(p^{(2)}_i\) as:

\[ l^{(1)}_i = F^T p^{(2)}_i \]

Line coefficients are defined up to a scale. They are normalized so that \(a_i^2+b_i^2=1\) .

Parameters

  • points — Input points. \(N \times 1\) or \(1 \times N\) matrix of type CV_32FC2 or vector .

  • whichImage — Index of the image (1 or 2) that contains the points .

  • F — Fundamental matrix that can be estimated using findFundamentalMat or stereoRectify .

  • lines — Output vector of the epipolar lines corresponding to the points in the other image. Each line \(ax + by + c=0\) is encoded by 3 numbers \((a, b, c)\) .

convertPointsFromHomogeneous()#

void cv::convertPointsFromHomogeneous(
InputArray src,
OutputArray dst,
int dtype = -1 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.convertPointsFromHomogeneous(src[, dst[, dtype]]) -> dst

Converts points from homogeneous to Euclidean space.

The function converts points homogeneous to Euclidean space using perspective projection. That is, each point (x1, x2, … x(n-1), xn) is converted to (x1/xn, x2/xn, …, x(n-1)/xn). When xn=0, the output point coordinates will be (0,0,0,…).

Parameters

  • src — Input vector of N-dimensional points.

  • dst — Output vector of N-1-dimensional points.

  • dtype — The desired output array depth (either CV_32F or CV_64F are currently supported). If it’s -1, then it’s set automatically to CV_32F or CV_64F, depending on the input depth.

convertPointsHomogeneous()#

void cv::convertPointsHomogeneous(
InputArray src,
OutputArray dst )

#include <opencv2/geometry/3d.hpp>

Converts points to/from homogeneous coordinates.

The function converts 2D or 3D points from/to homogeneous coordinates by calling either convertPointsToHomogeneous or convertPointsFromHomogeneous.

Note

The function is obsolete. Use one of the previous two functions instead.

Parameters

  • src — Input array or vector of 2D, 3D, or 4D points.

  • dst — Output vector of 2D, 3D, or 4D points.

convertPointsToHomogeneous()#

void cv::convertPointsToHomogeneous(
InputArray src,
OutputArray dst,
int dtype = -1 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.convertPointsToHomogeneous(src[, dst[, dtype]]) -> dst

Converts points from Euclidean to homogeneous space.

The function converts points from Euclidean to homogeneous space by appending 1’s to the tuple of point coordinates. That is, each point (x1, x2, …, xn) is converted to (x1, x2, …, xn, 1).

Parameters

  • src — Input vector of N-dimensional points.

  • dst — Output vector of N+1-dimensional points.

  • dtype — The desired output array depth (either CV_32F or CV_64F are currently supported). If it’s -1, then it’s set automatically to CV_32F or CV_64F, depending on the input depth.

correctMatches()#

void cv::correctMatches(
InputArray F,
InputArray points1,
InputArray points2,
OutputArray newPoints1,
OutputArray newPoints2 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.correctMatches(F, points1, points2[, newPoints1[, newPoints2]]) -> newPoints1, newPoints2

Refines coordinates of corresponding points.

The function implements the Optimal Triangulation Method (see Multiple View Geometry [133] for details). For each given point correspondence points1[i] <-> points2[i], and a fundamental matrix F, it computes the corrected correspondences newPoints1[i] <-> newPoints2[i] that minimize the geometric error \(d(points1[i], newPoints1[i])^2 + d(points2[i],newPoints2[i])^2\) (where \(d(a,b)\) is the geometric distance between points \(a\) and \(b\) ) subject to the epipolar constraint \(newPoints2^T \cdot F \cdot newPoints1 = 0\) .

Parameters

  • F — 3x3 fundamental matrix.

  • points1 — 1xN array containing the first set of points.

  • points2 — 1xN array containing the second set of points.

  • newPoints1 — The optimized points1.

  • newPoints2 — The optimized points2.

decomposeEssentialMat()#

void cv::decomposeEssentialMat(
InputArray E,
OutputArray R1,
OutputArray R2,
OutputArray t )

#include <opencv2/geometry/3d.hpp>

Python:

cv.decomposeEssentialMat(E[, R1[, R2[, t]]]) -> R1, R2, t

Decompose an essential matrix to possible rotations and translation.

This function decomposes the essential matrix E using svd decomposition [133]. In general, four possible poses exist for the decomposition of E. They are \([R_1, t]\), \([R_1, -t]\), \([R_2, t]\), \([R_2, -t]\).

If E gives the epipolar constraint \([p_2; 1]^T A^{-T} E A^{-1} [p_1; 1] = 0\) between the image points \(p_1\) in the first image and \(p_2\) in second image, then any of the tuples \([R_1, t]\), \([R_1, -t]\), \([R_2, t]\), \([R_2, -t]\) is a change of basis from the first camera’s coordinate system to the second camera’s coordinate system. However, by decomposing E, one can only get the direction of the translation. For this reason, the translation t is returned with unit length.

Parameters

  • E — The input essential matrix.

  • R1 — One possible rotation matrix.

  • R2 — Another possible rotation matrix.

  • t — One possible translation.

decomposeHomographyMat()#

int cv::decomposeHomographyMat(
InputArray H,
InputArray K,
OutputArrayOfArrays rotations,
OutputArrayOfArrays translations,
OutputArrayOfArrays normals )

#include <opencv2/geometry/3d.hpp>

Python:

cv.decomposeHomographyMat(H, K[, rotations[, translations[, normals]]]) -> retval, rotations, translations, normals

Decompose a homography matrix to rotation(s), translation(s) and plane normal(s).

This function extracts relative camera motion between two views of a planar object and returns up to four mathematical solution tuples of rotation, translation, and plane normal. The decomposition of the homography matrix H is described in detail in [202].

If the homography H, induced by the plane, gives the constraint

\[ s_i \vecthree{x'_i}{y'_i}{1} \sim H \vecthree{x_i}{y_i}{1} \]

on the source image points \(p_i\) and the destination image points \(p'_i\), then the tuple of rotations[k] and translations[k] is a change of basis from the source camera’s coordinate system to the destination camera’s coordinate system. However, by decomposing H, one can only get the translation normalized by the (typically unknown) depth of the scene, i.e. its direction but with normalized length.

If point correspondences are available, at least two solutions may further be invalidated, by applying positive depth constraint, i.e. all points must be in front of the camera.

Parameters

  • H — The input homography matrix between two images.

  • K — The input camera intrinsic matrix.

  • rotations — Array of rotation matrices.

  • translations — Array of translation matrices.

  • normals — Array of plane normal matrices.

decomposeProjectionMatrix()#

void cv::decomposeProjectionMatrix(
InputArray projMatrix,
OutputArray cameraMatrix,
OutputArray rotMatrix,
OutputArray transVect,
OutputArray rotMatrixX = noArray(),
OutputArray rotMatrixY = noArray(),
OutputArray rotMatrixZ = noArray(),
OutputArray eulerAngles = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.decomposeProjectionMatrix(projMatrix[, cameraMatrix[, rotMatrix[, transVect[, rotMatrixX[, rotMatrixY[, rotMatrixZ[, eulerAngles]]]]]]]) -> cameraMatrix, rotMatrix, transVect, rotMatrixX, rotMatrixY, rotMatrixZ, eulerAngles

Decomposes a projection matrix into a rotation matrix and a camera intrinsic matrix.

The function computes a decomposition of a projection matrix into a calibration and a rotation matrix and the position of a camera.

It optionally returns three rotation matrices, one for each axis, and three Euler angles that could be used in OpenGL. Note, there is always more than one sequence of rotations about the three principal axes that results in the same orientation of an object, e.g. see [277] . Returned three rotation matrices and corresponding three Euler angles are only one of the possible solutions.

The function is based on RQDecomp3x3 .

Parameters

  • projMatrix — 3x4 input projection matrix P.

  • cameraMatrix — Output 3x3 camera intrinsic matrix \(\cameramatrix{A}\).

  • rotMatrix — Output 3x3 external rotation matrix R.

  • transVect — Output 4x1 translation vector T.

  • rotMatrixX — Optional 3x3 rotation matrix around x-axis.

  • rotMatrixY — Optional 3x3 rotation matrix around y-axis.

  • rotMatrixZ — Optional 3x3 rotation matrix around z-axis.

  • eulerAngles — Optional three-element vector containing three Euler angles of rotation in degrees.

estimateAffine2D()#

Mat cv::estimateAffine2D(
InputArray from,
InputArray to,
OutputArray inliers = noArray(),
int method = RANSAC,
double ransacReprojThreshold = 3,
size_t maxIters = 2000,
double confidence = 0.99,
size_t refineIters = 10 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.estimateAffine2D(from_, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers
cv.estimateAffine2D(pts1, pts2, params[, inliers]) -> retval, inliers

Computes an optimal affine transformation between two 2D point sets.

It computes

\[\begin{split} \begin{bmatrix} x\\ y\\ \end{bmatrix} = \begin{bmatrix} a_{11} & a_{12}\\ a_{21} & a_{22}\\ \end{bmatrix} \begin{bmatrix} X\\ Y\\ \end{bmatrix} + \begin{bmatrix} b_1\\ b_2\\ \end{bmatrix} \end{split}\]

The function estimates an optimal 2D affine transformation between two 2D point sets using the selected robust algorithm.

The computed transformation is then refined further (using only inliers) with the Levenberg-Marquardt method to reduce the re-projection error even more.

Note

The RANSAC method can handle practically any ratio of outliers but needs a threshold to distinguish inliers from outliers. The method LMeDS does not need any threshold but it works correctly only when there are more than 50% of inliers.

Parameters

  • from — First input 2D point set containing \((X,Y)\).

  • to — Second input 2D point set containing \((x,y)\).

  • inliers — Output vector indicating which points are inliers (1-inlier, 0-outlier).

  • method — Robust method used to compute transformation. The following methods are possible:

    • RANSAC - RANSAC-based robust method

    • LMEDS - Least-Median robust method RANSAC is the default method.

  • ransacReprojThreshold — Maximum reprojection error in the RANSAC algorithm to consider a point as an inlier. Applies only to RANSAC.

  • maxIters — The maximum number of robust method iterations.

  • confidence — Confidence level, between 0 and 1, for the estimated transformation. Anything between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.

  • refineIters — Maximum number of iterations of refining algorithm (Levenberg-Marquardt). Passing 0 will disable refining, so the output matrix will be output of robust method.

Returns

Output 2D affine transformation matrix \(2 \times 3\) or empty matrix if transformation could not be estimated. The returned matrix has the following form:

\[\begin{split} \begin{bmatrix} a_{11} & a_{12} & b_1\\ a_{21} & a_{22} & b_2\\ \end{bmatrix} \end{split}\]

estimateAffine2D()#

Mat cv::estimateAffine2D(
InputArray pts1,
InputArray pts2,
OutputArray inliers,
const UsacParams & params )

#include <opencv2/geometry/3d.hpp>

Python:

cv.estimateAffine2D(from_, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers
cv.estimateAffine2D(pts1, pts2, params[, inliers]) -> retval, inliers

estimateAffine3D()#

cv::Mat cv::estimateAffine3D(
InputArray src,
InputArray dst,
double * scale = nullptr,
bool force_rotation = true )

#include <opencv2/geometry/3d.hpp>

Python:

cv.estimateAffine3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers
cv.estimateAffine3D(src, dst[, force_rotation]) -> retval, scale

Computes an optimal affine transformation between two 3D point sets.

It computes \(R,s,t\) minimizing \(\sum{i} dst_i - c \cdot R \cdot src_i \) where \(R\) is a 3x3 rotation matrix, \(t\) is a 3x1 translation vector and \(s\) is a scalar size value. This is an implementation of the algorithm by Umeyama [314] . The estimated affine transform has a homogeneous scale which is a subclass of affine transformations with 7 degrees of freedom. The paired point sets need to comprise at least 3 points each.

Parameters

  • src — First input 3D point set.

  • dst — Second input 3D point set.

  • scale — If null is passed, the scale parameter c will be assumed to be 1.0. Else the pointed-to variable will be set to the optimal scale.

  • force_rotation — If true, the returned rotation will never be a reflection. This might be unwanted, e.g. when optimizing a transform between a right- and a left-handed coordinate system.

Returns

3D affine transformation matrix \(3 \times 4\) of the form

\[\begin{split} T = \begin{bmatrix} R & t\\ \end{bmatrix} \end{split}\]

estimateAffine3D()#

bool cv::estimateAffine3D(
InputArray src,
InputArray dst,
OutputArray out,
OutputArray inliers,
double ransacThreshold = 3,
double confidence = 0.99 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.estimateAffine3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers
cv.estimateAffine3D(src, dst[, force_rotation]) -> retval, scale

Computes an optimal affine transformation between two 3D point sets.

It computes

\[\begin{split} \begin{bmatrix} x\\ y\\ z\\ \end{bmatrix} = \begin{bmatrix} a_{11} & a_{12} & a_{13}\\ a_{21} & a_{22} & a_{23}\\ a_{31} & a_{32} & a_{33}\\ \end{bmatrix} \begin{bmatrix} X\\ Y\\ Z\\ \end{bmatrix} + \begin{bmatrix} b_1\\ b_2\\ b_3\\ \end{bmatrix} \end{split}\]

The function estimates an optimal 3D affine transformation between two 3D point sets using the RANSAC algorithm.

Parameters

  • src — First input 3D point set containing \((X,Y,Z)\).

  • dst — Second input 3D point set containing \((x,y,z)\).

  • out — Output 3D affine transformation matrix \(3 \times 4\) of the form

    \[\begin{split} \begin{bmatrix} a_{11} & a_{12} & a_{13} & b_1\\ a_{21} & a_{22} & a_{23} & b_2\\ a_{31} & a_{32} & a_{33} & b_3\\ \end{bmatrix} \end{split}\]
  • inliers — Output vector indicating which points are inliers (1-inlier, 0-outlier).

  • ransacThreshold — Maximum reprojection error in the RANSAC algorithm to consider a point as an inlier.

  • confidence — Confidence level, between 0 and 1, for the estimated transformation. Anything between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.

Returns

Whether a solution was found.

estimateAffinePartial2D()#

cv::Mat cv::estimateAffinePartial2D(
InputArray from,
InputArray to,
OutputArray inliers = noArray(),
int method = RANSAC,
double ransacReprojThreshold = 3,
size_t maxIters = 2000,
double confidence = 0.99,
size_t refineIters = 10 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.estimateAffinePartial2D(from_, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers

Computes an optimal limited affine transformation with 4 degrees of freedom between two 2D point sets.

The function estimates an optimal 2D affine transformation with 4 degrees of freedom limited to combinations of translation, rotation, and uniform scaling. Uses the selected algorithm for robust estimation.

The computed transformation is then refined further (using only inliers) with the Levenberg-Marquardt method to reduce the re-projection error even more.

Estimated transformation matrix is:

\[\begin{split} \begin{bmatrix} \cos(\theta) \cdot s & -\sin(\theta) \cdot s & t_x \\ \sin(\theta) \cdot s & \cos(\theta) \cdot s & t_y \end{bmatrix} \end{split}\]

Where \( \theta \) is the rotation angle, \( s \) the scaling factor and \( t_x, t_y \) are translations in \( x, y \) axes respectively.

Note

The RANSAC method can handle practically any ratio of outliers but need a threshold to distinguish inliers from outliers. The method LMeDS does not need any threshold but it works correctly only when there are more than 50% of inliers.

Parameters

  • from — First input 2D point set.

  • to — Second input 2D point set.

  • inliers — Output vector indicating which points are inliers.

  • method — Robust method used to compute transformation. The following methods are possible:

    • RANSAC - RANSAC-based robust method

    • LMEDS - Least-Median robust method RANSAC is the default method.

  • ransacReprojThreshold — Maximum reprojection error in the RANSAC algorithm to consider a point as an inlier. Applies only to RANSAC.

  • maxIters — The maximum number of robust method iterations.

  • confidence — Confidence level, between 0 and 1, for the estimated transformation. Anything between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.

  • refineIters — Maximum number of iterations of refining algorithm (Levenberg-Marquardt). Passing 0 will disable refining, so the output matrix will be output of robust method.

Returns

Output 2D affine transformation (4 degrees of freedom) matrix \(2 \times 3\) or empty matrix if transformation could not be estimated.

estimateTranslation2D()#

cv::Vec2d cv::estimateTranslation2D(
InputArray from,
InputArray to,
OutputArray inliers = noArray(),
int method = RANSAC,
double ransacReprojThreshold = 3,
size_t maxIters = 2000,
double confidence = 0.99,
size_t refineIters = 0 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.estimateTranslation2D(from_, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers

Computes a pure 2D translation between two 2D point sets.

It computes

\[\begin{split} \begin{bmatrix} x\\ y \end{bmatrix} = \begin{bmatrix} 1 & 0\\ 0 & 1 \end{bmatrix} \begin{bmatrix} X\\ Y \end{bmatrix} + \begin{bmatrix} t_x\\ t_y \end{bmatrix}. \end{split}\]
\[\begin{split} \begin{bmatrix} 1 & 0 & t_x\\ 0 & 1 & t_y \end{bmatrix} \end{split}\]
cv::Vec2d t = cv::estimateTranslation2D(from, to, inliers);
cv::Mat T = (cv::Mat_<double>(2,3) << 1,0,t[0], 0,1,t[1]);

The function estimates a pure 2D translation between two 2D point sets using the selected robust algorithm. Inliers are determined by the reprojection error threshold.

Note

The RANSAC method can handle practically any ratio of outliers but needs a threshold to distinguish inliers from outliers. The method LMeDS does not need any threshold but works correctly only when there are more than 50% inliers.

Parameters

  • from — First input 2D point set containing \((X,Y)\).

  • to — Second input 2D point set containing \((x,y)\).

  • inliers — Output vector indicating which points are inliers (1-inlier, 0-outlier).

  • method — Robust method used to compute the transformation. The following methods are possible:

    • RANSAC - RANSAC-based robust method

    • LMEDS - Least-Median robust method RANSAC is the default method.

  • ransacReprojThreshold — Maximum reprojection error in the RANSAC algorithm to consider a point as an inlier. Applies only to RANSAC.

  • maxIters — The maximum number of robust method iterations.

  • confidence — Confidence level, between 0 and 1, for the estimated transformation. Anything between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation significantly. Values lower than 0.8–0.9 can result in an incorrectly estimated transformation.

  • refineIters — Maximum number of iterations of the refining algorithm. For pure translation the least-squares solution on inliers is closed-form, so passing 0 is recommended (no additional refine).

Returns

A 2D translation vector \([t_x, t_y]^T\) as cv::Vec2d. If the translation could not be estimated, both components are set to NaN and, if inliers is provided, the mask is filled with zeros.

estimateTranslation3D()#

bool cv::estimateTranslation3D(
InputArray src,
InputArray dst,
OutputArray out,
OutputArray inliers,
double ransacThreshold = 3,
double confidence = 0.99 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.estimateTranslation3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers

Computes an optimal translation between two 3D point sets.

It computes

\[\begin{split} \begin{bmatrix} x\\ y\\ z\\ \end{bmatrix} = \begin{bmatrix} X\\ Y\\ Z\\ \end{bmatrix} + \begin{bmatrix} b_1\\ b_2\\ b_3\\ \end{bmatrix} \end{split}\]

The function estimates an optimal 3D translation between two 3D point sets using the RANSAC algorithm.

Parameters

  • src — First input 3D point set containing \((X,Y,Z)\).

  • dst — Second input 3D point set containing \((x,y,z)\).

  • out — Output 3D translation vector \(3 \times 1\) of the form

    \[\begin{split} \begin{bmatrix} b_1 \\ b_2 \\ b_3 \\ \end{bmatrix} \end{split}\]
  • inliers — Output vector indicating which points are inliers (1-inlier, 0-outlier).

  • ransacThreshold — Maximum reprojection error in the RANSAC algorithm to consider a point as an inlier.

  • confidence — Confidence level, between 0 and 1, for the estimated transformation. Anything between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.

Returns

Whether a translation was found.

filterHomographyDecompByVisibleRefpoints()#

void cv::filterHomographyDecompByVisibleRefpoints(
InputArrayOfArrays rotations,
InputArrayOfArrays normals,
InputArray beforePoints,
InputArray afterPoints,
OutputArray possibleSolutions,
InputArray pointsMask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.filterHomographyDecompByVisibleRefpoints(rotations, normals, beforePoints, afterPoints[, possibleSolutions[, pointsMask]]) -> possibleSolutions

Filters homography decompositions based on additional information.

This function is intended to filter the output of the decomposeHomographyMat based on additional information as described in [202] . The summary of the method: the decomposeHomographyMat function returns 2 unique solutions and their “opposites” for a total of 4 solutions. If we have access to the sets of points visible in the camera frame before and after the homography transformation is applied, we can determine which are the true potential solutions and which are the opposites by verifying which homographies are consistent with all visible reference points being in front of the camera. The inputs are left unchanged; the filtered solution set is returned as indices into the existing one.

Parameters

  • rotations — Vector of rotation matrices.

  • normals — Vector of plane normal matrices.

  • beforePoints — Vector of (rectified) visible reference points before the homography is applied

  • afterPoints — Vector of (rectified) visible reference points after the homography is applied

  • possibleSolutions — Vector of int indices representing the viable solution set after filtering

  • pointsMask — optional Mat/Vector of CV_8U, CV_8S or CV_Bool type representing the mask for the inliers as given by the findHomography function

findEssentialMat()#

Mat cv::findEssentialMat(
InputArray points1,
InputArray points2,
double focal = 1.0,
Point2d pp = Point2d(0, 0),
int method = RANSAC,
double prob = 0.999,
double threshold = 1.0,
int maxIters = 1000,
OutputArray mask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findEssentialMat(points1, points2, cameraMatrix[, method[, prob[, threshold[, maxIters[, mask]]]]]) -> retval, mask
cv.findEssentialMat(points1, points2[, focal[, pp[, method[, prob[, threshold[, maxIters[, mask]]]]]]]) -> retval, mask
cv.findEssentialMat(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2[, method[, prob[, threshold[, mask]]]]) -> retval, mask
cv.findEssentialMat(points1, points2, cameraMatrix1, cameraMatrix2, dist_coeff1, dist_coeff2, params[, mask]) -> retval, mask

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function differs from the one above that it computes camera intrinsic matrix from focal length and principal point:

\[\begin{split} A = \begin{bmatrix} f & 0 & x_{pp} \\ 0 & f & y_{pp} \\ 0 & 0 & 1 \end{bmatrix} \end{split}\]

Parameters

  • points1 — Array of N (N >= 5) 2D points from the first image. The point coordinates should be floating-point (single or double precision).

  • points2 — Array of the second image points of the same size and format as points1 .

  • focal — focal length of the camera. Note that this function assumes that points1 and points2 are feature points from cameras with same focal length and principal point.

  • pp — principal point of the camera.

  • method — Method for computing a fundamental matrix.

    • RANSAC for the RANSAC algorithm.

    • LMEDS for the LMedS algorithm.

  • threshold — Parameter used for RANSAC. It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is considered an outlier and is not used for computing the final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise.

  • prob — Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of confidence (probability) that the estimated matrix is correct.

  • mask — Output array of N elements, every element of which is set to 0 for outliers and to 1 for the other points. The array is computed only in the RANSAC and LMedS methods.

  • maxIters — The maximum number of robust method iterations.

findEssentialMat()#

Mat cv::findEssentialMat(
InputArray points1,
InputArray points2,
InputArray cameraMatrix,
int method = RANSAC,
double prob = 0.999,
double threshold = 1.0,
int maxIters = 1000,
OutputArray mask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findEssentialMat(points1, points2, cameraMatrix[, method[, prob[, threshold[, maxIters[, mask]]]]]) -> retval, mask
cv.findEssentialMat(points1, points2[, focal[, pp[, method[, prob[, threshold[, maxIters[, mask]]]]]]]) -> retval, mask
cv.findEssentialMat(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2[, method[, prob[, threshold[, mask]]]]) -> retval, mask
cv.findEssentialMat(points1, points2, cameraMatrix1, cameraMatrix2, dist_coeff1, dist_coeff2, params[, mask]) -> retval, mask

Calculates an essential matrix from the corresponding points in two images.

This function estimates essential matrix based on the five-point algorithm solver in [231] . [281] is also a related. The epipolar geometry is described by the following equation:

\[ [p_2; 1]^T K^{-T} E K^{-1} [p_1; 1] = 0 \]

where \(E\) is an essential matrix, \(p_1\) and \(p_2\) are corresponding points in the first and the second images, respectively. The result of this function may be passed further to decomposeEssentialMat or recoverPose to recover the relative pose between cameras.

Parameters

  • points1 — Array of N (N >= 5) 2D points from the first image. The point coordinates should be floating-point (single or double precision).

  • points2 — Array of the second image points of the same size and format as points1.

  • cameraMatrix — Camera intrinsic matrix \(\cameramatrix{A}\) . Note that this function assumes that points1 and points2 are feature points from cameras with the same camera intrinsic matrix. If this assumption does not hold for your use case, use another function overload or undistortPoints with P = cv::NoArray() for both cameras to transform image points to normalized image coordinates, which are valid for the identity camera intrinsic matrix. When passing these coordinates, pass the identity matrix for this parameter.

  • method — Method for computing an essential matrix.

    • RANSAC for the RANSAC algorithm.

    • LMEDS for the LMedS algorithm.

  • prob — Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of confidence (probability) that the estimated matrix is correct.

  • threshold — Parameter used for RANSAC. It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is considered an outlier and is not used for computing the final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise.

  • mask — Output array of N elements, every element of which is set to 0 for outliers and to 1 for the other points. The array is computed only in the RANSAC and LMedS methods.

  • maxIters — The maximum number of robust method iterations.

findEssentialMat()#

Mat cv::findEssentialMat(
InputArray points1,
InputArray points2,
InputArray cameraMatrix1,
InputArray cameraMatrix2,
InputArray dist_coeff1,
InputArray dist_coeff2,
OutputArray mask,
const UsacParams & params )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findEssentialMat(points1, points2, cameraMatrix[, method[, prob[, threshold[, maxIters[, mask]]]]]) -> retval, mask
cv.findEssentialMat(points1, points2[, focal[, pp[, method[, prob[, threshold[, maxIters[, mask]]]]]]]) -> retval, mask
cv.findEssentialMat(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2[, method[, prob[, threshold[, mask]]]]) -> retval, mask
cv.findEssentialMat(points1, points2, cameraMatrix1, cameraMatrix2, dist_coeff1, dist_coeff2, params[, mask]) -> retval, mask

findEssentialMat()#

Mat cv::findEssentialMat(
InputArray points1,
InputArray points2,
InputArray cameraMatrix1,
InputArray distCoeffs1,
InputArray cameraMatrix2,
InputArray distCoeffs2,
int method = RANSAC,
double prob = 0.999,
double threshold = 1.0,
OutputArray mask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findEssentialMat(points1, points2, cameraMatrix[, method[, prob[, threshold[, maxIters[, mask]]]]]) -> retval, mask
cv.findEssentialMat(points1, points2[, focal[, pp[, method[, prob[, threshold[, maxIters[, mask]]]]]]]) -> retval, mask
cv.findEssentialMat(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2[, method[, prob[, threshold[, mask]]]]) -> retval, mask
cv.findEssentialMat(points1, points2, cameraMatrix1, cameraMatrix2, dist_coeff1, dist_coeff2, params[, mask]) -> retval, mask

Calculates an essential matrix from the corresponding points in two images from potentially two different cameras.

This function estimates essential matrix based on the five-point algorithm solver in [231] . [281] is also a related. The epipolar geometry is described by the following equation:

\[ [p_2; 1]^T K^{-T} E K^{-1} [p_1; 1] = 0 \]

where \(E\) is an essential matrix, \(p_1\) and \(p_2\) are corresponding points in the first and the second images, respectively. The result of this function may be passed further to decomposeEssentialMat or recoverPose to recover the relative pose between cameras.

Parameters

  • points1 — Array of N (N >= 5) 2D points from the first image. The point coordinates should be floating-point (single or double precision).

  • points2 — Array of the second image points of the same size and format as points1.

  • cameraMatrix1 — Camera matrix for the first camera \(K = \vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\) .

  • cameraMatrix2 — Camera matrix for the second camera \(K = \vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\) .

  • distCoeffs1 — Input vector of distortion coefficients for the first camera \((k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \tau_x, \tau_y]]]])\) of 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • distCoeffs2 — Input vector of distortion coefficients for the second camera \((k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \tau_x, \tau_y]]]])\) of 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • method — Method for computing an essential matrix.

    • RANSAC for the RANSAC algorithm.

    • LMEDS for the LMedS algorithm.

  • prob — Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of confidence (probability) that the estimated matrix is correct.

  • threshold — Parameter used for RANSAC. It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is considered an outlier and is not used for computing the final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise.

  • mask — Output array of N elements, every element of which is set to 0 for outliers and to 1 for the other points. The array is computed only in the RANSAC and LMedS methods.

findFundamentalMat()#

Mat cv::findFundamentalMat(
InputArray points1,
InputArray points2,
int method,
double ransacReprojThreshold,
double confidence,
int maxIters,
OutputArray mask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findFundamentalMat(points1, points2, method, ransacReprojThreshold, confidence, maxIters[, mask]) -> retval, mask
cv.findFundamentalMat(points1, points2[, method[, ransacReprojThreshold[, confidence[, mask]]]]) -> retval, mask
cv.findFundamentalMat(points1, points2, params[, mask]) -> retval, mask

Calculates a fundamental matrix from the corresponding points in two images.

The epipolar geometry is described by the following equation:

\[ [p_2; 1]^T F [p_1; 1] = 0 \]

where \(F\) is a fundamental matrix, \(p_1\) and \(p_2\) are corresponding points in the first and the second images, respectively.

The function calculates the fundamental matrix using one of four methods listed above and returns the found fundamental matrix. Normally just one matrix is found. But in case of the 7-point algorithm, the function may return up to 3 solutions ( \(9 \times 3\) matrix that stores all 3 matrices sequentially).

The calculated fundamental matrix may be passed further to computeCorrespondEpilines that finds the epipolar lines corresponding to the specified points. It can also be passed to stereoRectifyUncalibrated to compute the rectification transformation. :

// Example. Estimation of fundamental matrix using the RANSAC algorithm
int point_count = 100;
vector<Point2f> points1(point_count);
vector<Point2f> points2(point_count);

// initialize the points here ...
for( int i = 0; i < point_count; i++ )
{
    points1[i] = ...;
    points2[i] = ...;
}

Mat fundamental_matrix =
 findFundamentalMat(points1, points2, FM_RANSAC, 3, 0.99);

Parameters

  • points1 — Array of N points from the first image. The point coordinates should be floating-point (single or double precision).

  • points2 — Array of the second image points of the same size and format as points1 .

  • method — Method for computing a fundamental matrix.

    • FM_7POINT for a 7-point algorithm. \(N = 7\)

    • FM_8POINT for an 8-point algorithm. \(N \ge 8\)

    • FM_RANSAC for the RANSAC algorithm. \(N \ge 8\)

    • FM_LMEDS for the LMedS algorithm. \(N \ge 8\)

  • ransacReprojThreshold — Parameter used only for RANSAC. It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is considered an outlier and is not used for computing the final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise.

  • confidence — Parameter used for the RANSAC and LMedS methods only. It specifies a desirable level of confidence (probability) that the estimated matrix is correct.

  • mask — optional output mask

  • maxIters — The maximum number of robust method iterations.

findFundamentalMat()#

Mat cv::findFundamentalMat(
InputArray points1,
InputArray points2,
int method = FM_RANSAC,
double ransacReprojThreshold = 3.,
double confidence = 0.99,
OutputArray mask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findFundamentalMat(points1, points2, method, ransacReprojThreshold, confidence, maxIters[, mask]) -> retval, mask
cv.findFundamentalMat(points1, points2[, method[, ransacReprojThreshold[, confidence[, mask]]]]) -> retval, mask
cv.findFundamentalMat(points1, points2, params[, mask]) -> retval, mask

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

findFundamentalMat()#

Mat cv::findFundamentalMat(
InputArray points1,
InputArray points2,
OutputArray mask,
const UsacParams & params )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findFundamentalMat(points1, points2, method, ransacReprojThreshold, confidence, maxIters[, mask]) -> retval, mask
cv.findFundamentalMat(points1, points2[, method[, ransacReprojThreshold[, confidence[, mask]]]]) -> retval, mask
cv.findFundamentalMat(points1, points2, params[, mask]) -> retval, mask

findFundamentalMat()#

Mat cv::findFundamentalMat(
InputArray points1,
InputArray points2,
OutputArray mask,
int method = FM_RANSAC,
double ransacReprojThreshold = 3.,
double confidence = 0.99 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findFundamentalMat(points1, points2, method, ransacReprojThreshold, confidence, maxIters[, mask]) -> retval, mask
cv.findFundamentalMat(points1, points2[, method[, ransacReprojThreshold[, confidence[, mask]]]]) -> retval, mask
cv.findFundamentalMat(points1, points2, params[, mask]) -> retval, mask

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

findHomography()#

Mat cv::findHomography(
InputArray srcPoints,
InputArray dstPoints,
int method = 0,
double ransacReprojThreshold = 3,
OutputArray mask = noArray(),
const int maxIters = 2000,
const double confidence = 0.995 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findHomography(srcPoints, dstPoints[, method[, ransacReprojThreshold[, mask[, maxIters[, confidence]]]]]) -> retval, mask
cv.findHomography(srcPoints, dstPoints, params[, mask]) -> retval, mask

Finds a perspective transformation between two planes.

The function finds and returns the perspective transformation \(H\) between the source and the destination planes:

\[ s_i \vecthree{x'_i}{y'_i}{1} \sim H \vecthree{x_i}{y_i}{1} \]

so that the back-projection error

\[ \sum _i \left ( x'_i- \frac{h_{11} x_i + h_{12} y_i + h_{13}}{h_{31} x_i + h_{32} y_i + h_{33}} \right )^2+ \left ( y'_i- \frac{h_{21} x_i + h_{22} y_i + h_{23}}{h_{31} x_i + h_{32} y_i + h_{33}} \right )^2 \]

is minimized. If the parameter method is set to the default value 0, the function uses all the point pairs to compute an initial homography estimate with a simple least-squares scheme.

However, if not all of the point pairs ( \(srcPoints_i\), \(dstPoints_i\) ) fit the rigid perspective transformation (that is, there are some outliers), this initial estimate will be poor. In this case, you can use one of the three robust methods. The methods RANSAC, LMeDS and RHO try many different random subsets of the corresponding point pairs (of four pairs each, collinear pairs are discarded), estimate the homography matrix using this subset and a simple least-squares algorithm, and then compute the quality/goodness of the computed homography (which is the number of inliers for RANSAC or the least median re-projection error for LMeDS). The best subset is then used to produce the initial estimate of the homography matrix and the mask of inliers/outliers.

Regardless of the method, robust or not, the computed homography matrix is refined further (using inliers only in case of a robust method) with the Levenberg-Marquardt method to reduce the re-projection error even more.

The methods RANSAC and RHO can handle practically any ratio of outliers but need a threshold to distinguish inliers from outliers. The method LMeDS does not need any threshold but it works correctly only when there are more than 50% of inliers. Finally, if there are no outliers and the noise is rather small, use the default method (method=0).

The function is used to find initial intrinsic and extrinsic matrices. Homography matrix is determined up to a scale. If \(h_{33}\) is non-zero, the matrix is normalized so that \(h_{33}=1\).

Note

Whenever an \(H\) matrix cannot be estimated, an empty one will be returned.

Parameters

  • srcPoints — Coordinates of the points in the original plane, a matrix of the type CV_32FC2 or vector .

  • dstPoints — Coordinates of the points in the target plane, a matrix of the type CV_32FC2 or a vector .

  • method — Method used to compute a homography matrix. The following methods are possible:

    • 0 - a regular method using all the points, i.e., the least squares method

    • RANSAC - RANSAC-based robust method

    • LMEDS - Least-Median robust method

    • RHO - PROSAC-based robust method

  • ransacReprojThreshold — Maximum allowed reprojection error to treat a point pair as an inlier (used in the RANSAC and RHO methods only). That is, if

    \[ \| \texttt{dstPoints} _i - \texttt{convertPointsHomogeneous} ( \texttt{H} \cdot \texttt{srcPoints} _i) \|_2 > \texttt{ransacReprojThreshold} \]

    then the point \(i\) is considered as an outlier. If srcPoints and dstPoints are measured in pixels, it usually makes sense to set this parameter somewhere in the range of 1 to 10.

  • mask — Optional output mask set by a robust method ( RANSAC or LMeDS ). Note that the input mask values are ignored.

  • maxIters — The maximum number of RANSAC iterations.

  • confidence — Confidence level, between 0 and 1.

findHomography()#

Mat cv::findHomography(
InputArray srcPoints,
InputArray dstPoints,
OutputArray mask,
const UsacParams & params )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findHomography(srcPoints, dstPoints[, method[, ransacReprojThreshold[, mask[, maxIters[, confidence]]]]]) -> retval, mask
cv.findHomography(srcPoints, dstPoints, params[, mask]) -> retval, mask

findHomography()#

Mat cv::findHomography(
InputArray srcPoints,
InputArray dstPoints,
OutputArray mask,
int method = 0,
double ransacReprojThreshold = 3 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.findHomography(srcPoints, dstPoints[, method[, ransacReprojThreshold[, mask[, maxIters[, confidence]]]]]) -> retval, mask
cv.findHomography(srcPoints, dstPoints, params[, mask]) -> retval, mask

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

getDefaultNewCameraMatrix()#

Mat cv::getDefaultNewCameraMatrix(
InputArray cameraMatrix,
Size imgsize = Size(),
bool centerPrincipalPoint = false )

#include <opencv2/geometry/3d.hpp>

Python:

cv.getDefaultNewCameraMatrix(cameraMatrix[, imgsize[, centerPrincipalPoint]]) -> retval

Returns the default new camera matrix.

The function returns the camera matrix that is either an exact copy of the input cameraMatrix (when centerPrinicipalPoint=false ), or the modified one (when centerPrincipalPoint=true).

In the latter case, the new camera matrix will be:

\[\begin{split} \begin{bmatrix} f_x && 0 && ( \texttt{imgSize.width} -1)*0.5 \\ 0 && f_y && ( \texttt{imgSize.height} -1)*0.5 \\ 0 && 0 && 1 \end{bmatrix} , \end{split}\]

where \(f_x\) and \(f_y\) are \((0,0)\) and \((1,1)\) elements of cameraMatrix, respectively.

By default, the undistortion functions in OpenCV (see initUndistortRectifyMap, undistort) do not move the principal point. However, when you work with stereo, it is important to move the principal points in both views to the same y-coordinate (which is required by most of stereo correspondence algorithms), and may be to the same x-coordinate too. So, you can form the new camera matrix for each view where the principal points are located at the center.

Parameters

  • cameraMatrix — Input camera matrix.

  • imgsize — Camera view image size in pixels.

  • centerPrincipalPoint — Location of the principal point in the new camera matrix. The parameter indicates whether this location should be at the image center or not.

getOptimalNewCameraMatrix()#

Mat cv::getOptimalNewCameraMatrix(
InputArray cameraMatrix,
InputArray distCoeffs,
Size imageSize,
double alpha,
Size newImgSize = Size(),
Rect * validPixROI = 0,
bool centerPrincipalPoint = false )

#include <opencv2/geometry/3d.hpp>

Python:

cv.getOptimalNewCameraMatrix(cameraMatrix, distCoeffs, imageSize, alpha[, newImgSize[, centerPrincipalPoint]]) -> retval, validPixROI

Returns the new camera intrinsic matrix based on the free scaling parameter.

The function computes and returns the optimal new camera intrinsic matrix based on the free scaling parameter. By varying this parameter, you may retrieve only sensible pixels alpha=0 , keep all the original image pixels if there is valuable information in the corners alpha=1 , or get something in between. When alpha>0 , the undistorted result is likely to have some black pixels corresponding to “virtual” pixels outside of the captured distorted image. The original camera intrinsic matrix, distortion coefficients, the computed new camera intrinsic matrix, and newImageSize should be passed to initUndistortRectifyMap to produce the maps for remap .

Parameters

  • cameraMatrix — Input camera intrinsic matrix.

  • distCoeffs — Input vector of distortion coefficients \(\distcoeffs\). If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • imageSize — Original image size.

  • alpha — Free scaling parameter between 0 (when all the pixels in the undistorted image are valid) and 1 (when all the source image pixels are retained in the undistorted image). See stereoRectify for details.

  • newImgSize — Image size after rectification. By default, it is set to imageSize .

  • validPixROI — Optional output rectangle that outlines all-good-pixels region in the undistorted image. See roi1, roi2 description in stereoRectify .

  • centerPrincipalPoint — Optional flag that indicates whether in the new camera intrinsic matrix the principal point should be at the image center or not. By default, the principal point is chosen to best fit a subset of the source image (determined by alpha) to the corrected image.

Returns

new_camera_matrix Output new camera intrinsic matrix.

getUndistortRectangles()#

void cv::getUndistortRectangles(
InputArray cameraMatrix,
InputArray distCoeffs,
InputArray R,
InputArray newCameraMatrix,
Size imgSize,
Rect_< double > & inner,
Rect_< double > & outer )

#include <opencv2/geometry/3d.hpp>

Returns the inscribed and bounding rectangles for the “undisorted” image plane.

The functions emulates undistortion of the image plane using the specified camera matrix, distortion coefficients, the optional 3D rotation and the “new” camera matrix. In the case of noticeable radial (or maybe pinclusion) distortion the rectangular image plane is distorted and turns into some convex or concave shape. The function computes approximate inscribed (inner) and bounding (outer) rectangles after such undistortion. The rectangles can be used to adjust the newCameraMatrix so that the result image, for example, fits all the data from the original image (at the expense of possibly big “black” areas) or, for another example, gets rid of black areas at the expense some lost data near the original image edge. The function getOptimalNewCameraMatrix uses this function to compute the optimal new camera matrix.

Parameters

  • cameraMatrix — the original camera matrix.

  • distCoeffs — distortion coefficients.

  • R — the optional 3D rotation, applied before projection (see stereoRectify etc.)

  • newCameraMatrix — the new camera matrix after undistortion. Usually it matches the original cameraMatrix.

  • imgSize — the size of the image plane.

  • inner — the output maximal inscribed rectangle of the undistorted image plane.

  • outer — the output minimal bounding rectangle of the undistorted image plane.

matMulDeriv()#

void cv::matMulDeriv(
InputArray A,
InputArray B,
OutputArray dABdA,
OutputArray dABdB )

#include <opencv2/geometry/3d.hpp>

Python:

cv.matMulDeriv(A, B[, dABdA[, dABdB]]) -> dABdA, dABdB

Computes partial derivatives of the matrix product for each multiplied matrix.

The function computes partial derivatives of the elements of the matrix product \(A*B\) with regard to the elements of each of the two input matrices. The function is used to compute the Jacobian matrices in stereoCalibrate but can also be used in any other similar optimization function.

Parameters

  • A — First multiplied matrix.

  • B — Second multiplied matrix.

  • dABdA — First output derivative matrix d(A*B)/dA of size \(\texttt{A.rows*B.cols} \times {A.rows*A.cols}\) .

  • dABdB — Second output derivative matrix d(A*B)/dB of size \(\texttt{A.rows*B.cols} \times {B.rows*B.cols}\) .

projectPoints()#

void cv::projectPoints(
InputArray objectPoints,
InputArray rvec,
InputArray tvec,
InputArray cameraMatrix,
InputArray distCoeffs,
OutputArray imagePoints,
OutputArray dpdr,
OutputArray dpdt,
OutputArray dpdf = noArray(),
OutputArray dpdc = noArray(),
OutputArray dpdk = noArray(),
OutputArray dpdo = noArray(),
double aspectRatio = 0. )

#include <opencv2/geometry/3d.hpp>

Python:

cv.projectPoints(objectPoints, rvec, tvec, cameraMatrix, distCoeffs[, imagePoints[, jacobian[, aspectRatio]]]) -> imagePoints, jacobian
cv.projectPointsSepJ(objectPoints, rvec, tvec, cameraMatrix, distCoeffs[, imagePoints[, dpdr[, dpdt[, dpdf[, dpdc[, dpdk[, dpdo[, aspectRatio]]]]]]]]) -> imagePoints, dpdr, dpdt, dpdf, dpdc, dpdk, dpdo

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

projectPoints()#

void cv::projectPoints(
InputArray objectPoints,
InputArray rvec,
InputArray tvec,
InputArray cameraMatrix,
InputArray distCoeffs,
OutputArray imagePoints,
OutputArray jacobian = noArray(),
double aspectRatio = 0 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.projectPoints(objectPoints, rvec, tvec, cameraMatrix, distCoeffs[, imagePoints[, jacobian[, aspectRatio]]]) -> imagePoints, jacobian
cv.projectPointsSepJ(objectPoints, rvec, tvec, cameraMatrix, distCoeffs[, imagePoints[, dpdr[, dpdt[, dpdf[, dpdc[, dpdk[, dpdo[, aspectRatio]]]]]]]]) -> imagePoints, dpdr, dpdt, dpdf, dpdc, dpdk, dpdo

Projects 3D points to an image plane.

The function computes the 2D projections of 3D points to the image plane, given intrinsic and extrinsic camera parameters. Optionally, the function computes Jacobians -matrices of partial derivatives of image points coordinates (as functions of all the input parameters) with respect to the particular parameters, intrinsic and/or extrinsic. The Jacobians are used during the global optimization in calibrateCamera, solvePnP, and stereoCalibrate. The function itself can also be used to compute a re-projection error, given the current intrinsic and extrinsic parameters.

Note

Coordinate Systems:

  • Input (objectPoints): 3D points in the world coordinate frame.

  • Output (imagePoints): 2D projections in pixel coordinates of the image plane, with distortion applied. The coordinates \((u, v)\) are measured in pixels from the top-left corner of the image.

The transformation chain is: World coordinates → Camera coordinates (via rvec/tvec) → Normalized camera coordinates → Distortion applied → Pixel coordinates (via cameraMatrix).

Note

By setting rvec = tvec = \([0, 0, 0]\), or by setting cameraMatrix to a 3x3 identity matrix, or by passing zero distortion coefficients, one can get various useful partial cases of the function. This means, one can compute the distorted coordinates for a sparse set of points or apply a perspective transformation (and also compute the derivatives) in the ideal zero-distortion setup.

Parameters

  • objectPoints — Array of object points expressed wrt. the world coordinate frame. A 3xN/Nx3 1-channel or 1xN/Nx1 3-channel (or vector ), where N is the number of points in the view.

  • rvec — The rotation vector (Rodrigues) that, together with tvec, performs a change of basis from world to camera coordinate system, see calibrateCamera for details.

  • tvec — The translation vector, see parameter description above.

  • cameraMatrix — Camera intrinsic matrix \(\cameramatrix{A}\) .

  • distCoeffs — Input vector of distortion coefficients \(\distcoeffs\) . If the vector is empty, the zero distortion coefficients are assumed.

  • imagePoints — Output array of image points in pixel coordinates, 1xN/Nx1 2-channel, or vector .

  • jacobian — Optional output 2Nx(10+) jacobian matrix of derivatives of image points with respect to components of the rotation vector, translation vector, focal lengths, coordinates of the principal point and the distortion coefficients. In the old interface different components of the jacobian are returned via different output parameters.

  • aspectRatio — Optional “fixed aspect ratio” parameter. If the parameter is not 0, the function assumes that the aspect ratio ( \(f_x / f_y\)) is fixed and correspondingly adjusts the jacobian matrix.

recoverPose()#

int cv::recoverPose(
InputArray E,
InputArray points1,
InputArray points2,
InputArray cameraMatrix,
OutputArray R,
OutputArray t,
double distanceThresh,
InputOutputArray mask = noArray(),
OutputArray triangulatedPoints = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.recoverPose(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2[, E[, R[, t[, method[, prob[, threshold[, mask]]]]]]]) -> retval, E, R, t, mask
cv.recoverPose(E, points1, points2, cameraMatrix[, R[, t[, mask]]]) -> retval, R, t, mask
cv.recoverPose(E, points1, points2[, R[, t[, focal[, pp[, mask]]]]]) -> retval, R, t, mask
cv.recoverPose(E, points1, points2, cameraMatrix, distanceThresh[, R[, t[, mask[, triangulatedPoints]]]]) -> retval, R, t, mask, triangulatedPoints

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function differs from the one above that it outputs the triangulated 3D point that are used for the chirality check.

Parameters

  • E — The input essential matrix.

  • points1 — Array of N 2D points from the first image. The point coordinates should be floating-point (single or double precision).

  • points2 — Array of the second image points of the same size and format as points1.

  • cameraMatrix — Camera intrinsic matrix \(\cameramatrix{A}\) . Note that this function assumes that points1 and points2 are feature points from cameras with the same camera intrinsic matrix.

  • R — Output rotation matrix. Together with the translation vector, this matrix makes up a tuple that performs a change of basis from the first camera’s coordinate system to the second camera’s coordinate system. Note that, in general, t can not be used for this tuple, see the parameter description below.

  • t — Output translation vector. This vector is obtained by decomposeEssentialMat and therefore is only known up to scale, i.e. t is the direction of the translation vector and has unit length.

  • distanceThresh — threshold distance which is used to filter out far away points (i.e. infinite points).

  • mask — Input/output mask for inliers in points1 and points2. If it is not empty, then it marks inliers in points1 and points2 for the given essential matrix E. Only these inliers will be used to recover pose. In the output mask only inliers which pass the chirality check.

  • triangulatedPoints — 3D points which were reconstructed by triangulation.

recoverPose()#

int cv::recoverPose(
InputArray E,
InputArray points1,
InputArray points2,
InputArray cameraMatrix,
OutputArray R,
OutputArray t,
InputOutputArray mask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.recoverPose(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2[, E[, R[, t[, method[, prob[, threshold[, mask]]]]]]]) -> retval, E, R, t, mask
cv.recoverPose(E, points1, points2, cameraMatrix[, R[, t[, mask]]]) -> retval, R, t, mask
cv.recoverPose(E, points1, points2[, R[, t[, focal[, pp[, mask]]]]]) -> retval, R, t, mask
cv.recoverPose(E, points1, points2, cameraMatrix, distanceThresh[, R[, t[, mask[, triangulatedPoints]]]]) -> retval, R, t, mask, triangulatedPoints

Recovers the relative camera rotation and the translation from an estimated essential matrix and the corresponding points in two images, using chirality check. Returns the number of inliers that pass the check.

This function decomposes an essential matrix using decomposeEssentialMat and then verifies possible pose hypotheses by doing chirality check. The chirality check means that the triangulated 3D points should have positive depth. Some details can be found in [231].

This function can be used to process the output E and mask from findEssentialMat. In this scenario, points1 and points2 are the same input for findEssentialMat :

// Example. Estimation of fundamental matrix using the RANSAC algorithm
int point_count = 100;
vector<Point2f> points1(point_count);
vector<Point2f> points2(point_count);

// initialize the points here ...
for( int i = 0; i < point_count; i++ )
{
    points1[i] = ...;
    points2[i] = ...;
}

// cametra matrix with both focal lengths = 1, and principal point = (0, 0)
Mat cameraMatrix = Mat::eye(3, 3, CV_64F);

Mat E, R, t, mask;

E = findEssentialMat(points1, points2, cameraMatrix, RANSAC, 0.999, 1.0, mask);
recoverPose(E, points1, points2, cameraMatrix, R, t, mask);

Parameters

  • E — The input essential matrix.

  • points1 — Array of N 2D points from the first image. The point coordinates should be floating-point (single or double precision).

  • points2 — Array of the second image points of the same size and format as points1 .

  • cameraMatrix — Camera intrinsic matrix \(\cameramatrix{A}\) . Note that this function assumes that points1 and points2 are feature points from cameras with the same camera intrinsic matrix.

  • R — Output rotation matrix. Together with the translation vector, this matrix makes up a tuple that performs a change of basis from the first camera’s coordinate system to the second camera’s coordinate system. Note that, in general, t can not be used for this tuple, see the parameter described below.

  • t — Output translation vector. This vector is obtained by decomposeEssentialMat and therefore is only known up to scale, i.e. t is the direction of the translation vector and has unit length.

  • mask — Input/output mask for inliers in points1 and points2. If it is not empty, then it marks inliers in points1 and points2 for the given essential matrix E. Only these inliers will be used to recover pose. In the output mask only inliers which pass the chirality check.

recoverPose()#

int cv::recoverPose(
InputArray E,
InputArray points1,
InputArray points2,
OutputArray R,
OutputArray t,
double focal = 1.0,
Point2d pp = Point2d(0, 0),
InputOutputArray mask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.recoverPose(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2[, E[, R[, t[, method[, prob[, threshold[, mask]]]]]]]) -> retval, E, R, t, mask
cv.recoverPose(E, points1, points2, cameraMatrix[, R[, t[, mask]]]) -> retval, R, t, mask
cv.recoverPose(E, points1, points2[, R[, t[, focal[, pp[, mask]]]]]) -> retval, R, t, mask
cv.recoverPose(E, points1, points2, cameraMatrix, distanceThresh[, R[, t[, mask[, triangulatedPoints]]]]) -> retval, R, t, mask, triangulatedPoints

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function differs from the one above that it computes camera intrinsic matrix from focal length and principal point:

\[\begin{split} A = \begin{bmatrix} f & 0 & x_{pp} \\ 0 & f & y_{pp} \\ 0 & 0 & 1 \end{bmatrix} \end{split}\]

Parameters

  • E — The input essential matrix.

  • points1 — Array of N 2D points from the first image. The point coordinates should be floating-point (single or double precision).

  • points2 — Array of the second image points of the same size and format as points1 .

  • R — Output rotation matrix. Together with the translation vector, this matrix makes up a tuple that performs a change of basis from the first camera’s coordinate system to the second camera’s coordinate system. Note that, in general, t can not be used for this tuple, see the parameter description below.

  • t — Output translation vector. This vector is obtained by decomposeEssentialMat and therefore is only known up to scale, i.e. t is the direction of the translation vector and has unit length.

  • focal — Focal length of the camera. Note that this function assumes that points1 and points2 are feature points from cameras with same focal length and principal point.

  • pp — principal point of the camera.

  • mask — Input/output mask for inliers in points1 and points2. If it is not empty, then it marks inliers in points1 and points2 for the given essential matrix E. Only these inliers will be used to recover pose. In the output mask only inliers which pass the chirality check.

recoverPose()#

int cv::recoverPose(
InputArray points1,
InputArray points2,
InputArray cameraMatrix1,
InputArray distCoeffs1,
InputArray cameraMatrix2,
InputArray distCoeffs2,
OutputArray E,
OutputArray R,
OutputArray t,
int method = cv::RANSAC,
double prob = 0.999,
double threshold = 1.0,
InputOutputArray mask = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.recoverPose(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2[, E[, R[, t[, method[, prob[, threshold[, mask]]]]]]]) -> retval, E, R, t, mask
cv.recoverPose(E, points1, points2, cameraMatrix[, R[, t[, mask]]]) -> retval, R, t, mask
cv.recoverPose(E, points1, points2[, R[, t[, focal[, pp[, mask]]]]]) -> retval, R, t, mask
cv.recoverPose(E, points1, points2, cameraMatrix, distanceThresh[, R[, t[, mask[, triangulatedPoints]]]]) -> retval, R, t, mask, triangulatedPoints

Recovers the relative camera rotation and the translation from corresponding points in two images from two different cameras, using chirality check. Returns the number of inliers that pass the check.

This function decomposes an essential matrix using decomposeEssentialMat and then verifies possible pose hypotheses by doing chirality check. The chirality check means that the triangulated 3D points should have positive depth. Some details can be found in [231].

This function can be used to process the output E and mask from findEssentialMat. In this scenario, points1 and points2 are the same input for findEssentialMat.:

// Example. Estimation of fundamental matrix using the RANSAC algorithm
int point_count = 100;
vector<Point2f> points1(point_count);
vector<Point2f> points2(point_count);

// initialize the points here ...
for( int i = 0; i < point_count; i++ )
{
    points1[i] = ...;
    points2[i] = ...;
}

// Input: camera calibration of both cameras, for example using intrinsic chessboard calibration.
Mat cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2;

// Output: Essential matrix, relative rotation and relative translation.
Mat E, R, t, mask;

recoverPose(points1, points2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, E, R, t, mask);

Parameters

  • points1 — Array of N 2D points from the first image. The point coordinates should be floating-point (single or double precision).

  • points2 — Array of the second image points of the same size and format as points1 .

  • cameraMatrix1 — Input/output camera matrix for the first camera, the same as in calibrateCamera. Furthermore, for the stereo case, additional flags may be used, see below.

  • distCoeffs1 — Input/output vector of distortion coefficients, the same as in calibrateCamera.

  • cameraMatrix2 — Input/output camera matrix for the first camera, the same as in calibrateCamera. Furthermore, for the stereo case, additional flags may be used, see below.

  • distCoeffs2 — Input/output vector of distortion coefficients, the same as in calibrateCamera.

  • E — The output essential matrix.

  • R — Output rotation matrix. Together with the translation vector, this matrix makes up a tuple that performs a change of basis from the first camera’s coordinate system to the second camera’s coordinate system. Note that, in general, t can not be used for this tuple, see the parameter described below.

  • t — Output translation vector. This vector is obtained by decomposeEssentialMat and therefore is only known up to scale, i.e. t is the direction of the translation vector and has unit length.

  • method — Method for computing an essential matrix.

    • RANSAC for the RANSAC algorithm.

    • LMEDS for the LMedS algorithm.

  • prob — Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of confidence (probability) that the estimated matrix is correct.

  • threshold — Parameter used for RANSAC. It is the maximum distance from a point to an epipolar line in pixels, beyond which the point is considered an outlier and is not used for computing the final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the point localization, image resolution, and the image noise.

  • mask — Input/output mask for inliers in points1 and points2. If it is not empty, then it marks inliers in points1 and points2 for the given essential matrix E. Only these inliers will be used to recover pose. In the output mask only inliers which pass the chirality check.

Rodrigues()#

void cv::Rodrigues(
InputArray src,
OutputArray dst,
OutputArray jacobian = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.Rodrigues(src[, dst[, jacobian]]) -> dst, jacobian

Converts a rotation matrix to a rotation vector or vice versa.

\[\begin{split} \begin{array}{l} \theta \leftarrow norm(r) \\ r \leftarrow r/ \theta \\ R = \cos(\theta) I + (1- \cos{\theta} ) r r^T + \sin(\theta) \vecthreethree{0}{-r_z}{r_y}{r_z}{0}{-r_x}{-r_y}{r_x}{0} \end{array} \end{split}\]

Inverse transformation can be also done easily, since

\[ \sin ( \theta ) \vecthreethree{0}{-r_z}{r_y}{r_z}{0}{-r_x}{-r_y}{r_x}{0} = \frac{R - R^T}{2} \]

A rotation vector is a convenient and most compact representation of a rotation matrix (since any rotation matrix has just 3 degrees of freedom). The representation is used in the global 3D geometry optimization procedures like calibrateCamera, stereoCalibrate, or solvePnP .

Note

More information about the computation of the derivative of a 3D rotation matrix with respect to its exponential coordinate can be found in:

  • A Compact Formula for the Derivative of a 3-D Rotation in Exponential Coordinates, Guillermo Gallego, Anthony J. Yezzi [110]

Useful information on SE(3) and Lie Groups can be found in:

  • A tutorial on SE(3) transformation parameterizations and on-manifold optimization, Jose-Luis Blanco [34]

  • Lie Groups for 2D and 3D Transformation, Ethan Eade [89]

  • A micro Lie theory for state estimation in robotics, Joan Solà, Jérémie Deray, Dinesh Atchuthan [279]

Parameters

  • src — Input rotation vector (3x1 or 1x3) or rotation matrix (3x3).

  • dst — Output rotation matrix (3x3) or rotation vector (3x1 or 1x3), respectively.

  • jacobian — Optional output Jacobian matrix, 3x9 or 9x3, which is a matrix of partial derivatives of the output array components with respect to the input array components.

RQDecomp3x3()#

Vec3d cv::RQDecomp3x3(
InputArray src,
OutputArray mtxR,
OutputArray mtxQ,
OutputArray Qx = noArray(),
OutputArray Qy = noArray(),
OutputArray Qz = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.RQDecomp3x3(src[, mtxR[, mtxQ[, Qx[, Qy[, Qz]]]]]) -> retval, mtxR, mtxQ, Qx, Qy, Qz

Computes an RQ decomposition of 3x3 matrices.

The function computes a RQ decomposition using the given rotations. This function is used in decomposeProjectionMatrix to decompose the left 3x3 submatrix of a projection matrix into a camera and a rotation matrix.

It optionally returns three rotation matrices, one for each axis, and the three Euler angles in degrees (as the return value) that could be used in OpenGL. Note, there is always more than one sequence of rotations about the three principal axes that results in the same orientation of an object, e.g. see [277] . Returned three rotation matrices and corresponding three Euler angles are only one of the possible solutions.

Parameters

  • src — 3x3 input matrix.

  • mtxR — Output 3x3 upper-triangular matrix.

  • mtxQ — Output 3x3 orthogonal matrix.

  • Qx — Optional output 3x3 rotation matrix around x-axis.

  • Qy — Optional output 3x3 rotation matrix around y-axis.

  • Qz — Optional output 3x3 rotation matrix around z-axis.

sampsonDistance()#

double cv::sampsonDistance(
InputArray pt1,
InputArray pt2,
InputArray F )

#include <opencv2/geometry/3d.hpp>

Python:

cv.sampsonDistance(pt1, pt2, F) -> retval

Calculates the Sampson Distance between two points.

The function cv::sampsonDistance calculates and returns the first order approximation of the geometric error as:

\[ sd( \texttt{pt1} , \texttt{pt2} )= \frac{(\texttt{pt2}^t \cdot \texttt{F} \cdot \texttt{pt1})^2} {((\texttt{F} \cdot \texttt{pt1})(0))^2 + ((\texttt{F} \cdot \texttt{pt1})(1))^2 + ((\texttt{F}^t \cdot \texttt{pt2})(0))^2 + ((\texttt{F}^t \cdot \texttt{pt2})(1))^2} \]

The fundamental matrix may be calculated using the findFundamentalMat function. See [133] 11.4.3 for details.

Parameters

  • pt1 — first homogeneous 2d point

  • pt2 — second homogeneous 2d point

  • F — fundamental matrix

Returns

The computed Sampson distance.

solveP3P()#

int cv::solveP3P(
InputArray objectPoints,
InputArray imagePoints,
InputArray cameraMatrix,
InputArray distCoeffs,
OutputArrayOfArrays rvecs,
OutputArrayOfArrays tvecs,
int flags )

#include <opencv2/geometry/3d.hpp>

Python:

cv.solveP3P(objectPoints, imagePoints, cameraMatrix, distCoeffs, flags[, rvecs[, tvecs]]) -> retval, rvecs, tvecs

Finds an object pose \( {}^{c}\mathbf{T}_o \) from 3 3D-2D point correspondences.

Perspective projection, from object to camera frame

See also

calib3d_solvePnP

The function estimates the object pose given 3 object points, their corresponding image projections, as well as the camera intrinsic matrix and the distortion coefficients.

Note

The solutions are sorted by reprojection errors (lowest to highest).

Parameters

  • objectPoints — Array of object points in the object coordinate space, 3x3 1-channel or 1x3/3x1 3-channel. vector can be also passed here.

  • imagePoints — Array of corresponding image points, 3x2 1-channel or 1x3/3x1 2-channel. vector can be also passed here.

  • cameraMatrix — Input camera intrinsic matrix \(\cameramatrix{A}\) .

  • distCoeffs — Input vector of distortion coefficients \(\distcoeffs\). If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • rvecs — Output rotation vectors (see Rodrigues ) that, together with tvecs, brings points from the model coordinate system to the camera coordinate system. A P3P problem has up to 4 solutions.

  • tvecs — Output translation vectors.

  • flags — Method for solving a P3P problem:

    • SOLVEPNP_P3P Method is based on the paper of Ding, Y., Yang, J., Larsson, V., Olsson, C., & Åstrom, K. “Revisiting the P3P Problem” ([79]).

    • SOLVEPNP_AP3P Method is based on the paper of T. Ke and S. Roumeliotis. “An Efficient Algebraic Solution to the Perspective-Three-Point Problem” ([163]).

solvePnP()#

bool cv::solvePnP(
InputArray objectPoints,
InputArray imagePoints,
InputArray cameraMatrix,
InputArray distCoeffs,
OutputArray rvec,
OutputArray tvec,
bool useExtrinsicGuess = false,
int flags = SOLVEPNP_ITERATIVE )

#include <opencv2/geometry/3d.hpp>

Python:

cv.solvePnP(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, flags]]]]) -> retval, rvec, tvec

Finds an object pose \( {}^{c}\mathbf{T}_o \) from 3D-2D point correspondences:

Perspective projection, from object to camera frame

See also

calib3d_solvePnP

This function returns the rotation and the translation vectors that transform a 3D point expressed in the object coordinate frame to the camera coordinate frame, using different methods:

  • P3P methods (SOLVEPNP_P3P, SOLVEPNP_AP3P): need 4 input points to return a unique solution.

  • SOLVEPNP_IPPE Input points must be >= 4 and object points must be coplanar.

  • SOLVEPNP_IPPE_SQUARE Special case suitable for marker pose estimation. Number of input points must be 4. Object points must be defined in the following order:

    • point 0: [-squareLength / 2, squareLength / 2, 0]

    • point 1: [ squareLength / 2, squareLength / 2, 0]

    • point 2: [ squareLength / 2, -squareLength / 2, 0]

    • point 3: [-squareLength / 2, -squareLength / 2, 0]

  • for all the other flags, number of input points must be >= 4 and object points can be in any configuration.

More information about Perspective-n-Points is described in calib3d_solvePnP

Note

  • An example of how to use solvePnP for planar augmented reality can be found at opencv_source_code/samples/python/plane_ar.py

  • If you are using Python:

    • Numpy array slices won’t work as input because solvePnP requires contiguous arrays (enforced by the assertion using cv::Mat::checkVector() around line 55 of modules/3d/src/solvepnp.cpp version 2.4.9)

    • The P3P algorithm requires image points to be in an array of shape (N,1,2) due to its calling of undistortPoints (around line 75 of modules/3d/src/solvepnp.cpp version 2.4.9) which requires 2-channel information.

    • Thus, given some data D = np.array(…) where D.shape = (N,M), in order to use a subset of it as, e.g., imagePoints, one must effectively copy it into a new array: imagePoints = np.ascontiguousarray(D[:,:2]).reshape((N,1,2))

  • The minimum number of points is 4 in the general case. In the case of SOLVEPNP_P3P and SOLVEPNP_AP3P methods, it is required to use exactly 4 points (the first 3 points are used to estimate all the solutions of the P3P problem, the last one is used to retain the best solution that minimizes the reprojection error).

  • With SOLVEPNP_ITERATIVE method and useExtrinsicGuess=true, the minimum number of points is 3 (3 points are sufficient to compute a pose but there are up to 4 solutions). The initial solution should be close to the global solution to converge. The function returns true if some solution is found. User code is responsible for solution quality assessment.

  • With SOLVEPNP_IPPE input points must be >= 4 and object points must be coplanar.

  • With SOLVEPNP_IPPE_SQUARE this is a special case suitable for marker pose estimation. Number of input points must be 4. Object points must be defined in the following order:

    • point 0: [-squareLength / 2, squareLength / 2, 0]

    • point 1: [ squareLength / 2, squareLength / 2, 0]

    • point 2: [ squareLength / 2, -squareLength / 2, 0]

    • point 3: [-squareLength / 2, -squareLength / 2, 0]

Parameters

  • objectPoints — Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel, where N is the number of points. vector can be also passed here.

  • imagePoints — Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel, where N is the number of points. vector can be also passed here.

  • cameraMatrix — Input camera intrinsic matrix \(\cameramatrix{A}\) .

  • distCoeffs — Input vector of distortion coefficients \(\distcoeffs\). If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • rvec — Output rotation vector (see Rodrigues ) that, together with tvec, brings points from the model coordinate system to the camera coordinate system.

  • tvec — Output translation vector.

  • useExtrinsicGuess — Parameter used for SOLVEPNP_ITERATIVE. If true (1), the function uses the provided rvec and tvec values as initial approximations of the rotation and translation vectors, respectively, and further optimizes them.

  • flags — Method for solving a PnP problem: see calib3d_solvePnP_flags

solvePnPGeneric()#

int cv::solvePnPGeneric(
InputArray objectPoints,
InputArray imagePoints,
InputArray cameraMatrix,
InputArray distCoeffs,
OutputArrayOfArrays rvecs,
OutputArrayOfArrays tvecs,
bool useExtrinsicGuess = false,
int flags = SOLVEPNP_ITERATIVE,
InputArray rvec = noArray(),
InputArray tvec = noArray(),
OutputArray reprojectionError = noArray() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.solvePnPGeneric(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvecs[, tvecs[, useExtrinsicGuess[, flags[, rvec[, tvec[, reprojectionError]]]]]]]) -> retval, rvecs, tvecs, reprojectionError

Finds an object pose \( {}^{c}\mathbf{T}_o \) from 3D-2D point correspondences.

Perspective projection, from object to camera frame

See also

calib3d_solvePnP

This function returns a list of all the possible solutions (a solution is a <rotation vector, translation vector> couple), depending on the number of input points and the chosen method:

  • P3P methods (SOLVEPNP_P3P, SOLVEPNP_AP3P): 3 or 4 input points. Number of returned solutions can be between 0 and 4 with 3 input points.

  • SOLVEPNP_IPPE Input points must be >= 4 and object points must be coplanar. Returns 2 solutions.

  • SOLVEPNP_IPPE_SQUARE Special case suitable for marker pose estimation. Number of input points must be 4 and 2 solutions are returned. Object points must be defined in the following order:

    • point 0: [-squareLength / 2, squareLength / 2, 0]

    • point 1: [ squareLength / 2, squareLength / 2, 0]

    • point 2: [ squareLength / 2, -squareLength / 2, 0]

    • point 3: [-squareLength / 2, -squareLength / 2, 0]

  • for all the other flags, number of input points must be >= 4 and object points can be in any configuration. Only 1 solution is returned.

More information is described in calib3d_solvePnP

Note

  • An example of how to use solvePnP for planar augmented reality can be found at opencv_source_code/samples/python/plane_ar.py

  • If you are using Python:

    • Numpy array slices won’t work as input because solvePnP requires contiguous arrays (enforced by the assertion using cv::Mat::checkVector() around line 55 of modules/3d/src/solvepnp.cpp version 2.4.9)

    • The P3P algorithm requires image points to be in an array of shape (N,1,2) due to its calling of undistortPoints (around line 75 of modules/3d/src/solvepnp.cpp version 2.4.9) which requires 2-channel information.

    • Thus, given some data D = np.array(…) where D.shape = (N,M), in order to use a subset of it as, e.g., imagePoints, one must effectively copy it into a new array: imagePoints = np.ascontiguousarray(D[:,:2]).reshape((N,1,2))

  • The minimum number of points is 4 in the general case. In the case of SOLVEPNP_P3P and SOLVEPNP_AP3P methods, it is required to use exactly 4 points (the first 3 points are used to estimate all the solutions of the P3P problem, the last one is used to retain the best solution that minimizes the reprojection error).

  • With SOLVEPNP_ITERATIVE method and useExtrinsicGuess=true, the minimum number of points is 3 (3 points are sufficient to compute a pose but there are up to 4 solutions). The initial solution should be close to the global solution to converge.

  • With SOLVEPNP_IPPE input points must be >= 4 and object points must be coplanar.

  • With SOLVEPNP_IPPE_SQUARE this is a special case suitable for marker pose estimation. Number of input points must be 4. Object points must be defined in the following order:

    • point 0: [-squareLength / 2, squareLength / 2, 0]

    • point 1: [ squareLength / 2, squareLength / 2, 0]

    • point 2: [ squareLength / 2, -squareLength / 2, 0]

    • point 3: [-squareLength / 2, -squareLength / 2, 0]

  • With SOLVEPNP_SQPNP input points must be >= 3

Parameters

  • objectPoints — Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel, where N is the number of points. vector can be also passed here.

  • imagePoints — Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel, where N is the number of points. vector can be also passed here.

  • cameraMatrix — Input camera intrinsic matrix \(\cameramatrix{A}\) .

  • distCoeffs — Input vector of distortion coefficients \(\distcoeffs\). If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • rvecs — Vector of output rotation vectors (see Rodrigues ) that, together with tvecs, brings points from the model coordinate system to the camera coordinate system.

  • tvecs — Vector of output translation vectors.

  • useExtrinsicGuess — Parameter used for SOLVEPNP_ITERATIVE. If true (1), the function uses the provided rvec and tvec values as initial approximations of the rotation and translation vectors, respectively, and further optimizes them.

  • flags — Method for solving a PnP problem: see calib3d_solvePnP_flags

  • rvec — Rotation vector used to initialize an iterative PnP refinement algorithm, when flag is SOLVEPNP_ITERATIVE and useExtrinsicGuess is set to true.

  • tvec — Translation vector used to initialize an iterative PnP refinement algorithm, when flag is SOLVEPNP_ITERATIVE and useExtrinsicGuess is set to true.

  • reprojectionError — Optional vector of reprojection error, that is the RMS error ( \( \text{RMSE} = \sqrt{\frac{\sum_{i}^{N} \left ( \hat{y_i} - y_i \right )^2}{N}} \)) between the input image points and the 3D object points projected with the estimated pose.

solvePnPRansac()#

bool cv::solvePnPRansac(
InputArray objectPoints,
InputArray imagePoints,
InputArray cameraMatrix,
InputArray distCoeffs,
OutputArray rvec,
OutputArray tvec,
bool useExtrinsicGuess = false,
int iterationsCount = 100,
float reprojectionError = 8.0,
double confidence = 0.99,
OutputArray inliers = noArray(),
int flags = SOLVEPNP_ITERATIVE )

#include <opencv2/geometry/3d.hpp>

Python:

cv.solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, iterationsCount[, reprojectionError[, confidence[, inliers[, flags]]]]]]]]) -> retval, rvec, tvec, inliers
cv.solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, inliers[, params]]]]) -> retval, cameraMatrix, rvec, tvec, inliers

Finds an object pose \( {}^{c}\mathbf{T}_o \) from 3D-2D point correspondences using the RANSAC scheme to deal with bad matches.

Perspective projection, from object to camera frame

See also

calib3d_solvePnP

The function estimates an object pose given a set of object points, their corresponding image projections, as well as the camera intrinsic matrix and the distortion coefficients. This function finds such a pose that minimizes reprojection error, that is, the sum of squared distances between the observed projections imagePoints and the projected (using projectPoints ) objectPoints. The use of RANSAC makes the function resistant to outliers.

Note

  • An example of how to use solvePnPRansac for object detection can be found at tutorial_real_time_pose

  • The default method used to estimate the camera pose for the Minimal Sample Sets step is SOLVEPNP_EPNP. Exceptions are:

  • The method used to estimate the camera pose using all the inliers is defined by the flags parameters unless it is equal to SOLVEPNP_P3P or SOLVEPNP_AP3P. In this case, the method SOLVEPNP_EPNP will be used instead.

Parameters

  • objectPoints — Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel, where N is the number of points. vector can be also passed here.

  • imagePoints — Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel, where N is the number of points. vector can be also passed here.

  • cameraMatrix — Input camera intrinsic matrix \(\cameramatrix{A}\) .

  • distCoeffs — Input vector of distortion coefficients \(\distcoeffs\). If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • rvec — Output rotation vector (see Rodrigues ) that, together with tvec, brings points from the model coordinate system to the camera coordinate system.

  • tvec — Output translation vector.

  • useExtrinsicGuess — Parameter used for SOLVEPNP_ITERATIVE. If true (1), the function uses the provided rvec and tvec values as initial approximations of the rotation and translation vectors, respectively, and further optimizes them.

  • iterationsCount — Number of iterations.

  • reprojectionError — Inlier threshold value used by the RANSAC procedure. The parameter value is the maximum allowed distance between the observed and computed point projections to consider it an inlier.

  • confidence — The probability that the algorithm produces a useful result.

  • inliers — Output vector that contains indices of inliers in objectPoints and imagePoints .

  • flags — Method for solving a PnP problem (see solvePnP ).

solvePnPRansac()#

bool cv::solvePnPRansac(
InputArray objectPoints,
InputArray imagePoints,
InputOutputArray cameraMatrix,
InputArray distCoeffs,
OutputArray rvec,
OutputArray tvec,
OutputArray inliers,
const UsacParams & params = UsacParams() )

#include <opencv2/geometry/3d.hpp>

Python:

cv.solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, iterationsCount[, reprojectionError[, confidence[, inliers[, flags]]]]]]]]) -> retval, rvec, tvec, inliers
cv.solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, inliers[, params]]]]) -> retval, cameraMatrix, rvec, tvec, inliers

solvePnPRefineLM()#

void cv::solvePnPRefineLM(
InputArray objectPoints,
InputArray imagePoints,
InputArray cameraMatrix,
InputArray distCoeffs,
InputOutputArray rvec,
InputOutputArray tvec,
TermCriteria criteria = TermCriteria(TermCriteria::EPS+TermCriteria::COUNT, 20, FLT_EPSILON) )

#include <opencv2/geometry/3d.hpp>

Python:

cv.solvePnPRefineLM(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec[, criteria]) -> rvec, tvec

Refine a pose (the translation and the rotation that transform a 3D point expressed in the object coordinate frame to the camera coordinate frame) from a 3D-2D point correspondences and starting from an initial solution.

See also

calib3d_solvePnP

The function refines the object pose given at least 3 object points, their corresponding image projections, an initial solution for the rotation and translation vector, as well as the camera intrinsic matrix and the distortion coefficients. The function minimizes the projection error with respect to the rotation and the translation vectors, according to a Levenberg-Marquardt iterative minimization [200] [88] process.

Parameters

  • objectPoints — Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel, where N is the number of points. vector can also be passed here.

  • imagePoints — Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel, where N is the number of points. vector can also be passed here.

  • cameraMatrix — Input camera intrinsic matrix \(\cameramatrix{A}\) .

  • distCoeffs — Input vector of distortion coefficients \(\distcoeffs\). If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • rvec — Input/Output rotation vector (see Rodrigues ) that, together with tvec, brings points from the model coordinate system to the camera coordinate system. Input values are used as an initial solution.

  • tvec — Input/Output translation vector. Input values are used as an initial solution.

  • criteria — Criteria when to stop the Levenberg-Marquard iterative algorithm.

solvePnPRefineVVS()#

void cv::solvePnPRefineVVS(
InputArray objectPoints,
InputArray imagePoints,
InputArray cameraMatrix,
InputArray distCoeffs,
InputOutputArray rvec,
InputOutputArray tvec,
TermCriteria criteria = TermCriteria(TermCriteria::EPS+TermCriteria::COUNT, 20, FLT_EPSILON),
double VVSlambda = 1 )

#include <opencv2/geometry/3d.hpp>

Python:

cv.solvePnPRefineVVS(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec[, criteria[, VVSlambda]]) -> rvec, tvec

Refine a pose (the translation and the rotation that transform a 3D point expressed in the object coordinate frame to the camera coordinate frame) from a 3D-2D point correspondences and starting from an initial solution.

See also

calib3d_solvePnP

The function refines the object pose given at least 3 object points, their corresponding image projections, an initial solution for the rotation and translation vector, as well as the camera intrinsic matrix and the distortion coefficients. The function minimizes the projection error with respect to the rotation and the translation vectors, using a virtual visual servoing (VVS) [58] [204] scheme.

Parameters

  • objectPoints — Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel, where N is the number of points. vector can also be passed here.

  • imagePoints — Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel, where N is the number of points. vector can also be passed here.

  • cameraMatrix — Input camera intrinsic matrix \(\cameramatrix{A}\) .

  • distCoeffs — Input vector of distortion coefficients \(\distcoeffs\). If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • rvec — Input/Output rotation vector (see Rodrigues ) that, together with tvec, brings points from the model coordinate system to the camera coordinate system. Input values are used as an initial solution.

  • tvec — Input/Output translation vector. Input values are used as an initial solution.

  • criteria — Criteria when to stop the Levenberg-Marquard iterative algorithm.

  • VVSlambda — Gain for the virtual visual servoing control law, equivalent to the \(\alpha\) gain in the Damped Gauss-Newton formulation.

triangulatePoints()#

void cv::triangulatePoints(
InputArray projMatr1,
InputArray projMatr2,
InputArray projPoints1,
InputArray projPoints2,
OutputArray points4D )

#include <opencv2/geometry/3d.hpp>

Python:

cv.triangulatePoints(projMatr1, projMatr2, projPoints1, projPoints2[, points4D]) -> points4D

This function reconstructs 3-dimensional points (in homogeneous coordinates) by using their observations with a stereo camera.

Note

Keep in mind that all input data should be of float type in order for this function to work.

If the projection matrices from stereoRectify are used, then the returned points are represented in the first camera’s rectified coordinate system.

Parameters

  • projMatr1 — 3x4 projection matrix of the first camera, i.e. this matrix projects 3D points given in the world’s coordinate system into the first image.

  • projMatr2 — 3x4 projection matrix of the second camera, i.e. this matrix projects 3D points given in the world’s coordinate system into the second image.

  • projPoints1 — 2xN array of feature points in the first image. In the case of the c++ version, it can be also a vector of feature points or two-channel matrix of size 1xN or Nx1.

  • projPoints2 — 2xN array of corresponding points in the second image. In the case of the c++ version, it can be also a vector of feature points or two-channel matrix of size 1xN or Nx1.

  • points4D — 4xN array of reconstructed points in homogeneous coordinates. These points are returned in the world’s coordinate system.

undistortImagePoints()#

void cv::undistortImagePoints(
InputArray src,
OutputArray dst,
InputArray cameraMatrix,
InputArray distCoeffs,
TermCriteria = TermCriteria(TermCriteria::MAX_ITER, 5, 0.01) )

#include <opencv2/geometry/3d.hpp>

Python:

cv.undistortImagePoints(src, cameraMatrix, distCoeffs[, dst[, arg1]]) -> dst

Compute undistorted image points position.

Parameters

  • src — Observed points position, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel (CV_32FC2 or CV_64FC2) (or vector ).

  • dst — Output undistorted points position (1xN/Nx1 2-channel or vector ).

  • cameraMatrix — Camera matrix \(\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\) .

  • distCoeffs — Distortion coefficients

undistortPoints()#

void cv::undistortPoints(
InputArray src,
OutputArray dst,
InputArray cameraMatrix,
InputArray distCoeffs,
InputArray R = noArray(),
InputArray P = noArray(),
TermCriteria criteria = TermCriteria(TermCriteria::MAX_ITER, 5, 0.01) )

#include <opencv2/geometry/3d.hpp>

Python:

cv.undistortPoints(src, cameraMatrix, distCoeffs[, dst[, R[, P[, criteria]]]]) -> dst

Computes the ideal point coordinates from the observed point coordinates.

The function is similar to undistort and initUndistortRectifyMap but it operates on a sparse set of points instead of a raster image. Also the function performs a reverse transformation to projectPoints. In case of a 3D object, it does not reconstruct its 3D coordinates, but for a planar object, it does, up to a translation vector, if the proper R is specified.

For each observed point coordinate \((u, v)\) the function computes:

\[\begin{split} \begin{array}{l} x^{"} \leftarrow (u - c_x)/f_x \\ y^{"} \leftarrow (v - c_y)/f_y \\ (x',y') = undistort(x^{"},y^{"}, \texttt{distCoeffs}) \\ {[X\,Y\,W]} ^T \leftarrow R*[x' \, y' \, 1]^T \\ x \leftarrow X/W \\ y \leftarrow Y/W \\ \text{only performed if P is specified:} \\ u' \leftarrow x {f'}_x + {c'}_x \\ v' \leftarrow y {f'}_y + {c'}_y \end{array} \end{split}\]

where undistort is an approximate iterative algorithm that estimates the normalized original point coordinates out of the normalized distorted point coordinates (“normalized” means that the coordinates do not depend on the camera matrix).

The function can be used for both a stereo camera head or a monocular camera (when R is empty).

Note

Coordinate Systems:

  • Input (src): Points are expected in pixel coordinates of the distorted image, i.e., coordinates \((u, v)\) measured in pixels from the top-left corner of the image.

  • Output (dst): The coordinate system of output points depends on parameter P:

    • If P is provided (not empty): Output points are in pixel coordinates of the rectified/undistorted image plane, using the camera matrix P.

    • If P is empty or identity: Output points are in normalized camera coordinates (also called “normalized image coordinates”), which are dimensionless coordinates \((x, y)\) in the camera’s focal plane, related to pixel coordinates by: \(x = (u - c_x) / f_x\) and \(y = (v - c_y) / f_y\). These normalized coordinates are independent of the camera’s intrinsic parameters and are useful for 3D reconstruction or epipolar geometry.

Parameters

  • src — Observed point coordinates in pixel coordinates of the distorted image, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel (CV_32FC2 or CV_64FC2) (or vector ).

  • dst — Output ideal point coordinates (1xN/Nx1 2-channel or vector ) after undistortion and reverse perspective transformation. If matrix P is identity or omitted, dst will contain normalized point coordinates.

  • cameraMatrix — Camera matrix \(\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\) .

  • distCoeffs — Input vector of distortion coefficients \((k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \tau_x, \tau_y]]]])\) of 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are assumed.

  • R — Rectification transformation in the object space (3x3 matrix). R1 or R2 computed by stereoRectify can be passed here. If the matrix is empty, the identity transformation is used.

  • P — New camera matrix (3x3) or new projection matrix (3x4) \(\begin{bmatrix} {f'}_x & 0 & {c'}_x & t_x \\ 0 & {f'}_y & {c'}_y & t_y \\ 0 & 0 & 1 & t_z \end{bmatrix}\). P1 or P2 computed by stereoRectify can be passed here. If the matrix is empty, the identity new camera matrix is used and output will be in normalized coordinates.

  • criteria — termination criteria for the iterative point undistortion algorithm