Skip to content

Commit 781fbde

Browse files
Merge pull request opencv#17368 from themightyoarfish:cv2eigen-doc
* Add documentation about usage of cv2eigen functions in eigen.hpp * Fixed Doxygen syntax. Co-authored-by: Alexander Smorkalov <[email protected]>
1 parent 1b336bb commit 781fbde

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

modules/core/include/opencv2/core/eigen.hpp

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,18 @@
6666
namespace cv
6767
{
6868

69-
//! @addtogroup core_eigen
69+
/** @addtogroup core_eigen
70+
These functions are provided for OpenCV-Eigen interoperability. They convert `Mat`
71+
objects to corresponding `Eigen::Matrix` objects and vice-versa. Consult the [Eigen
72+
documentation](https://eigen.tuxfamily.org/dox/group__TutorialMatrixClass.html) for
73+
information about the `Matrix` template type.
74+
75+
@note Using these functions requires the `Eigen/Dense` or similar header to be
76+
included before this header.
77+
*/
7078
//! @{
7179

72-
#ifdef OPENCV_EIGEN_TENSOR_SUPPORT
80+
#if defined(OPENCV_EIGEN_TENSOR_SUPPORT) || defined(CV_DOXYGEN)
7381
/** @brief Converts an Eigen::Tensor to a cv::Mat.
7482
7583
The method converts an Eigen::Tensor with shape (H x W x C) to a cv::Mat where:

0 commit comments

Comments
 (0)