Skip to content

Commit c72a832

Browse files
author
AleksandrPanov
committed
fix docs
1 parent 7ce8a88 commit c72a832

File tree

2 files changed

+15
-13
lines changed

2 files changed

+15
-13
lines changed

modules/aruco/include/opencv2/aruco.hpp

+12-11
Original file line numberDiff line numberDiff line change
@@ -223,9 +223,8 @@ CV_EXPORTS_W void detectMarkers(InputArray image, const Ptr<Dictionary> &diction
223223
/** @brief
224224
* rvec/tvec define the right handed coordinate system of the marker.
225225
* PatternPos defines center this system and axes direction.
226-
* Axis X (red color) - first coordinate
227-
* Axis Y (green color) - second coordinate
228-
* Axis Z (blue color) - third coordinate
226+
* Axis X (red color) - first coordinate, axis Y (green color) - second coordinate,
227+
* axis Z (blue color) - third coordinate.
229228
* @sa estimatePoseSingleMarkers(), @ref tutorial_aruco_detection
230229
*/
231230
enum PatternPos {
@@ -251,11 +250,11 @@ enum PatternPos {
251250

252251
/** @brief
253252
* Pose estimation parameters
254-
* @param pattern Defines center this system and axes direction.
253+
* @param pattern Defines center this system and axes direction (default PatternPos::CCW_center).
255254
* @param useExtrinsicGuess Parameter used for SOLVEPNP_ITERATIVE. If true (1), the function uses the provided
256255
* rvec and tvec values as initial approximations of the rotation and translation vectors, respectively, and further
257-
* optimizes them.
258-
* @param solvePnPMethod Method for solving a PnP problem: see @ref calib3d_solvePnP_flags.
256+
* optimizes them (default false).
257+
* @param solvePnPMethod Method for solving a PnP problem: see @ref calib3d_solvePnP_flags (default SOLVEPNP_ITERATIVE).
259258
* @sa PatternPos, solvePnP(), @ref tutorial_aruco_detection
260259
*/
261260
struct CV_EXPORTS_W EstimateParameters {
@@ -291,20 +290,22 @@ struct CV_EXPORTS_W EstimateParameters {
291290
* Each element in tvecs corresponds to the specific marker in imgPoints.
292291
* @param _objPoints array of object points of all the marker corners
293292
* @param estimateParameters set the origin of coordinate system and the coordinates of the four corners of the marker
294-
* (default EstimateParameters::CW_top_left_corner)
293+
* (default estimateParameters.pattern = PatternPos::CCW_center, estimateParameters.useExtrinsicGuess = false,
294+
* estimateParameters.solvePnPMethod = SOLVEPNP_ITERATIVE).
295295
*
296296
* This function receives the detected markers and returns their pose estimation respect to
297297
* the camera individually. So for each marker, one rotation and translation vector is returned.
298298
* The returned transformation is the one that transforms points from each marker coordinate system
299299
* to the camera coordinate system.
300-
* The marker coordinate system is centered on the middle of the marker (by default), with the Z axis
301-
* perpendicular to the marker plane.
302-
* The coordinates of the four corners of the marker in its own coordinate system are:
300+
* The marker coordinate system is centered on the middle (by default) or on the top-left corner of the marker,
301+
* with the Z axis perpendicular to the marker plane.
302+
* estimateParameters defines the coordinates of the four corners of the marker in its own coordinate system (by default) are:
303303
* (-markerLength/2, markerLength/2, 0), (markerLength/2, markerLength/2, 0),
304304
* (markerLength/2, -markerLength/2, 0), (-markerLength/2, -markerLength/2, 0)
305305
* @sa use cv::drawFrameAxes to get world coordinate system axis for object points
306-
* @sa PatternPos
307306
* @sa @ref tutorial_aruco_detection
307+
* @sa EstimateParameters
308+
* @sa PatternPos
308309
*/
309310
CV_EXPORTS_W void estimatePoseSingleMarkers(InputArrayOfArrays corners, float markerLength,
310311
InputArray cameraMatrix, InputArray distCoeffs,

modules/aruco/tutorials/aruco_detection/aruco_detection.markdown

+3-2
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,9 @@ translation vectors of the estimated poses will be in the same unit
286286
- The output parameters `rvecs` and `tvecs` are the rotation and translation vectors respectively, for each of the markers
287287
in `markerCorners`.
288288

289-
The marker coordinate system that is assumed by this function is placed in the top left corner of the marker
290-
with the Z axis pointing out, as in the following image. Axis-color correspondences are X: red, Y: green, Z: blue. Note the axis directions of the rotated markers in this image.
289+
The marker coordinate system that is assumed by this function is placed in the center (by default) or
290+
in the top left corner of the marker with the Z axis pointing out, as in the following image.
291+
Axis-color correspondences are X: red, Y: green, Z: blue. Note the axis directions of the rotated markers in this image.
291292

292293
![Image with axes drawn](images/singlemarkersaxes.jpg)
293294

0 commit comments

Comments
 (0)