Skip to content

Commit e2ba6ca

Browse files
author
AleksandrPanov
committed
update docs
1 parent 522bba3 commit e2ba6ca

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

modules/aruco/include/opencv2/aruco.hpp

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,24 @@ namespace cv {
1111
namespace aruco {
1212

1313
/**
14+
* @defgroup aruco Aruco markers, module functionality was moved to objdetect module
15+
* @{
16+
* ArUco Marker Detection, module functionality was moved to objdetect module
17+
* @sa ArucoDetector, CharucoDetector, Board, GridBoard, CharucoBoard
18+
* @}
19+
*/
20+
21+
//! @addtogroup aruco
22+
//! @{
23+
24+
/** @brief detect markers
1425
@deprecated Use class ArucoDetector::detectMarkers
1526
*/
1627
CV_EXPORTS_W void detectMarkers(InputArray image, const Ptr<Dictionary> &dictionary, OutputArrayOfArrays corners,
1728
OutputArray ids, const Ptr<DetectorParameters> &parameters = makePtr<DetectorParameters>(),
1829
OutputArrayOfArrays rejectedImgPoints = noArray());
1930

20-
/**
31+
/** @brief refine detected markers
2132
@deprecated Use class ArucoDetector::refineDetectedMarkers
2233
*/
2334
CV_EXPORTS_W void refineDetectedMarkers(InputArray image,const Ptr<Board> &board,
@@ -28,13 +39,13 @@ CV_EXPORTS_W void refineDetectedMarkers(InputArray image,const Ptr<Board> &boar
2839
bool checkAllOrders = true, OutputArray recoveredIdxs = noArray(),
2940
const Ptr<DetectorParameters> &parameters = makePtr<DetectorParameters>());
3041

31-
/**
32-
@deprecated Use Board::draw
42+
/** @brief draw planar board
43+
@deprecated Use Board::generateImage
3344
*/
3445
CV_EXPORTS_W void drawPlanarBoard(const Ptr<Board> &board, Size outSize, OutputArray img, int marginSize,
3546
int borderBits);
3647

37-
/**
48+
/** @brief get board object and image points
3849
@deprecated Use Board::matchImagePoints
3950
*/
4051
CV_EXPORTS_W void getBoardObjectAndImagePoints(const Ptr<Board> &board, InputArrayOfArrays detectedCorners,
@@ -144,6 +155,8 @@ CV_EXPORTS_W void estimatePoseSingleMarkers(InputArrayOfArrays corners, float ma
144155
*/
145156
CV_EXPORTS_W bool testCharucoCornersCollinear(const Ptr<CharucoBoard> &board, InputArray charucoIds);
146157

158+
//! @}
159+
147160
}
148161
}
149162

modules/aruco/include/opencv2/aruco/charuco.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ namespace aruco {
4040
* Only visible corners are returned. For each corner, its corresponding identifier is
4141
* also returned in charucoIds.
4242
* The function returns the number of interpolated corners.
43+
*
44+
* @deprecated Use CharucoDetector::detectBoard
4345
*/
4446
CV_EXPORTS_W int interpolateCornersCharuco(InputArrayOfArrays markerCorners, InputArray markerIds,
4547
InputArray image, const Ptr<CharucoBoard> &board,
@@ -69,6 +71,8 @@ CV_EXPORTS_W int interpolateCornersCharuco(InputArrayOfArrays markerCorners, Inp
6971
* are returned in the diamondCorners and diamondIds parameters. If camera calibration parameters
7072
* are provided, the diamond search is based on reprojection. If not, diamond search is based on
7173
* homography. Homography is faster than reprojection, but less accurate.
74+
*
75+
* @deprecated Use CharucoDetector::detectDiamonds
7276
*/
7377
CV_EXPORTS_W void detectCharucoDiamond(InputArray image, InputArrayOfArrays markerCorners,
7478
InputArray markerIds, float squareMarkerLengthRate,

0 commit comments

Comments
 (0)