Skip to content

Commit 83cb56d

Browse files
committed
Mark deprecated methods
1 parent 78a377a commit 83cb56d

File tree

1 file changed

+2
-63
lines changed

1 file changed

+2
-63
lines changed

modules/aruco/include/opencv2/aruco.hpp

Lines changed: 2 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -41,34 +41,7 @@ CV_EXPORTS_W void getBoardObjectAndImagePoints(const Ptr<Board> &board, InputArr
4141
InputArray detectedIds, OutputArray objPoints, OutputArray imgPoints);
4242

4343

44-
/**
45-
* @brief Pose estimation for a board of markers
46-
*
47-
* @param corners vector of already detected markers corners. For each marker, its four corners
48-
* are provided, (e.g std::vector<std::vector<cv::Point2f> > ). For N detected markers, the
49-
* dimensions of this array should be Nx4. The order of the corners should be clockwise.
50-
* @param ids list of identifiers for each marker in corners
51-
* @param board layout of markers in the board. The layout is composed by the marker identifiers
52-
* and the positions of each marker corner in the board reference system.
53-
* @param cameraMatrix input 3x3 floating-point camera matrix
54-
* \f$A = \vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\f$
55-
* @param distCoeffs vector of distortion coefficients
56-
* \f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6],[s_1, s_2, s_3, s_4]])\f$ of 4, 5, 8 or 12 elements
57-
* @param rvec Output vector (e.g. cv::Mat) corresponding to the rotation vector of the board
58-
* (see cv::Rodrigues). Used as initial guess if not empty.
59-
* @param tvec Output vector (e.g. cv::Mat) corresponding to the translation vector of the board.
60-
* @param useExtrinsicGuess defines whether initial guess for \b rvec and \b tvec will be used or not.
61-
* Used as initial guess if not empty.
62-
*
63-
* This function receives the detected markers and returns the pose of a marker board composed
64-
* by those markers.
65-
* A Board of marker has a single world coordinate system which is defined by the board layout.
66-
* The returned transformation is the one that transforms points from the board coordinate system
67-
* to the camera coordinate system.
68-
* Input markers that are not included in the board layout are ignored.
69-
* The function returns the number of markers from the input employed for the board pose estimation.
70-
* Note that returning a 0 means the pose has not been estimated.
71-
* @sa use cv::drawFrameAxes to get world coordinate system axis for object points
44+
/** @deprecated Use cv::solvePnP
7245
*/
7346
CV_EXPORTS_W int estimatePoseBoard(InputArrayOfArrays corners, InputArray ids, const Ptr<Board> &board,
7447
InputArray cameraMatrix, InputArray distCoeffs, InputOutputArray rvec,
@@ -98,41 +71,7 @@ CV_EXPORTS_W bool estimatePoseCharucoBoard(InputArray charucoCorners, InputArray
9871
InputArray distCoeffs, InputOutputArray rvec,
9972
InputOutputArray tvec, bool useExtrinsicGuess = false);
10073

101-
/**
102-
* @brief Pose estimation for single markers
103-
*
104-
* @param corners vector of already detected markers corners. For each marker, its four corners
105-
* are provided, (e.g std::vector<std::vector<cv::Point2f> > ). For N detected markers,
106-
* the dimensions of this array should be Nx4. The order of the corners should be clockwise.
107-
* @sa detectMarkers
108-
* @param markerLength the length of the markers' side. The returning translation vectors will
109-
* be in the same unit. Normally, unit is meters.
110-
* @param cameraMatrix input 3x3 floating-point camera matrix
111-
* \f$A = \vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\f$
112-
* @param distCoeffs vector of distortion coefficients
113-
* \f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6],[s_1, s_2, s_3, s_4]])\f$ of 4, 5, 8 or 12 elements
114-
* @param rvecs array of output rotation vectors (@sa Rodrigues) (e.g. std::vector<cv::Vec3d>).
115-
* Each element in rvecs corresponds to the specific marker in imgPoints.
116-
* @param tvecs array of output translation vectors (e.g. std::vector<cv::Vec3d>).
117-
* Each element in tvecs corresponds to the specific marker in imgPoints.
118-
* @param objPoints array of object points of all the marker corners
119-
* @param estimateParameters set the origin of coordinate system and the coordinates of the four corners of the marker
120-
* (default estimateParameters.pattern = PatternPositionType::ARUCO_CCW_CENTER, estimateParameters.useExtrinsicGuess = false,
121-
* estimateParameters.solvePnPMethod = SOLVEPNP_ITERATIVE).
122-
*
123-
* This function receives the detected markers and returns their pose estimation respect to
124-
* the camera individually. So for each marker, one rotation and translation vector is returned.
125-
* The returned transformation is the one that transforms points from each marker coordinate system
126-
* to the camera coordinate system.
127-
* The marker coordinate system is centered on the middle (by default) or on the top-left corner of the marker,
128-
* with the Z axis perpendicular to the marker plane.
129-
* estimateParameters defines the coordinates of the four corners of the marker in its own coordinate system (by default) are:
130-
* (-markerLength/2, markerLength/2, 0), (markerLength/2, markerLength/2, 0),
131-
* (markerLength/2, -markerLength/2, 0), (-markerLength/2, -markerLength/2, 0)
132-
* @sa use cv::drawFrameAxes to get world coordinate system axis for object points
133-
* @sa @ref tutorial_aruco_detection
134-
* @sa EstimateParameters
135-
* @sa PatternPositionType
74+
/** @deprecated Use cv::solvePnP
13675
*/
13776
CV_EXPORTS_W void estimatePoseSingleMarkers(InputArrayOfArrays corners, float markerLength,
13877
InputArray cameraMatrix, InputArray distCoeffs,

0 commit comments

Comments
 (0)