From e2ba6ca3f6609216f3b80f23eca249ecdebc7872 Mon Sep 17 00:00:00 2001 From: AleksandrPanov Date: Thu, 22 Dec 2022 20:32:18 +0300 Subject: [PATCH] update docs --- modules/aruco/include/opencv2/aruco.hpp | 21 +++++++++++++++---- .../aruco/include/opencv2/aruco/charuco.hpp | 4 ++++ 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/modules/aruco/include/opencv2/aruco.hpp b/modules/aruco/include/opencv2/aruco.hpp index 01bd1e22f..2e022ef83 100644 --- a/modules/aruco/include/opencv2/aruco.hpp +++ b/modules/aruco/include/opencv2/aruco.hpp @@ -11,13 +11,24 @@ namespace cv { namespace aruco { /** + * @defgroup aruco Aruco markers, module functionality was moved to objdetect module + * @{ + * ArUco Marker Detection, module functionality was moved to objdetect module + * @sa ArucoDetector, CharucoDetector, Board, GridBoard, CharucoBoard + * @} + */ + +//! @addtogroup aruco +//! @{ + +/** @brief detect markers @deprecated Use class ArucoDetector::detectMarkers */ CV_EXPORTS_W void detectMarkers(InputArray image, const Ptr &dictionary, OutputArrayOfArrays corners, OutputArray ids, const Ptr ¶meters = makePtr(), OutputArrayOfArrays rejectedImgPoints = noArray()); -/** +/** @brief refine detected markers @deprecated Use class ArucoDetector::refineDetectedMarkers */ CV_EXPORTS_W void refineDetectedMarkers(InputArray image,const Ptr &board, @@ -28,13 +39,13 @@ CV_EXPORTS_W void refineDetectedMarkers(InputArray image,const Ptr &boar bool checkAllOrders = true, OutputArray recoveredIdxs = noArray(), const Ptr ¶meters = makePtr()); -/** -@deprecated Use Board::draw +/** @brief draw planar board +@deprecated Use Board::generateImage */ CV_EXPORTS_W void drawPlanarBoard(const Ptr &board, Size outSize, OutputArray img, int marginSize, int borderBits); -/** +/** @brief get board object and image points @deprecated Use Board::matchImagePoints */ CV_EXPORTS_W void getBoardObjectAndImagePoints(const Ptr &board, InputArrayOfArrays detectedCorners, @@ -144,6 +155,8 @@ CV_EXPORTS_W void estimatePoseSingleMarkers(InputArrayOfArrays corners, float ma */ CV_EXPORTS_W bool testCharucoCornersCollinear(const Ptr &board, InputArray charucoIds); +//! @} + } } diff --git a/modules/aruco/include/opencv2/aruco/charuco.hpp b/modules/aruco/include/opencv2/aruco/charuco.hpp index 2f5c14f0b..7bc7c06b7 100644 --- a/modules/aruco/include/opencv2/aruco/charuco.hpp +++ b/modules/aruco/include/opencv2/aruco/charuco.hpp @@ -40,6 +40,8 @@ namespace aruco { * Only visible corners are returned. For each corner, its corresponding identifier is * also returned in charucoIds. * The function returns the number of interpolated corners. + * + * @deprecated Use CharucoDetector::detectBoard */ CV_EXPORTS_W int interpolateCornersCharuco(InputArrayOfArrays markerCorners, InputArray markerIds, InputArray image, const Ptr &board, @@ -69,6 +71,8 @@ CV_EXPORTS_W int interpolateCornersCharuco(InputArrayOfArrays markerCorners, Inp * are returned in the diamondCorners and diamondIds parameters. If camera calibration parameters * are provided, the diamond search is based on reprojection. If not, diamond search is based on * homography. Homography is faster than reprojection, but less accurate. + * + * @deprecated Use CharucoDetector::detectDiamonds */ CV_EXPORTS_W void detectCharucoDiamond(InputArray image, InputArrayOfArrays markerCorners, InputArray markerIds, float squareMarkerLengthRate,