Commit d7bd662c authored by catree's avatar catree

Add a note in the documentation about Mat::ones and mat::eye. With…

Add a note in the documentation about Mat::ones and mat::eye. With multi-channels type (e.g. CV_8UC3), only the first channel is treated.
parent 7fe07279
...@@ -1324,7 +1324,7 @@ public: ...@@ -1324,7 +1324,7 @@ public:
/** @brief Returns a zero array of the specified size and type. /** @brief Returns a zero array of the specified size and type.
The method returns a Matlab-style zero array initializer. It can be used to quickly form a constant The method returns a Matlab-style zero array initializer. It can be used to quickly form a constant
array as a function parameter, part of a matrix expression, or as a matrix initializer. : array as a function parameter, part of a matrix expression, or as a matrix initializer:
@code @code
Mat A; Mat A;
A = Mat::zeros(3, 3, CV_32F); A = Mat::zeros(3, 3, CV_32F);
...@@ -1360,6 +1360,8 @@ public: ...@@ -1360,6 +1360,8 @@ public:
The above operation does not form a 100x100 matrix of 1's and then multiply it by 3. Instead, it The above operation does not form a 100x100 matrix of 1's and then multiply it by 3. Instead, it
just remembers the scale factor (3 in this case) and use it when actually invoking the matrix just remembers the scale factor (3 in this case) and use it when actually invoking the matrix
initializer. initializer.
@note In case of multi-channels type, only the first channel will be initialized with 1's, the
others will be set to 0's.
@param rows Number of rows. @param rows Number of rows.
@param cols Number of columns. @param cols Number of columns.
@param type Created matrix type. @param type Created matrix type.
...@@ -1387,6 +1389,8 @@ public: ...@@ -1387,6 +1389,8 @@ public:
// make a 4x4 diagonal matrix with 0.1's on the diagonal. // make a 4x4 diagonal matrix with 0.1's on the diagonal.
Mat A = Mat::eye(4, 4, CV_32F)*0.1; Mat A = Mat::eye(4, 4, CV_32F)*0.1;
@endcode @endcode
@note In case of multi-channels type, identity matrix will be initialized only for the first channel,
the others will be set to 0's
@param rows Number of rows. @param rows Number of rows.
@param cols Number of columns. @param cols Number of columns.
@param type Created matrix type. @param type Created matrix type.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment