Skip to content

Commit 570083f

Browse files
i9482:
Removing description for cv::NormTypes that's already in cv::norm Masking out NORM_TYPE_MASK from docs since it's not intended to be exposed to user
1 parent b32685c commit 570083f

File tree

1 file changed

+4
-18
lines changed
  • modules/core/include/opencv2/core

1 file changed

+4
-18
lines changed

modules/core/include/opencv2/core/base.hpp

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -151,30 +151,16 @@ enum DecompTypes {
151151
DECOMP_NORMAL = 16
152152
};
153153

154-
/** norm types
155-
- For one array:
156-
\f[norm = \forkthree{\|\texttt{src1}\|_{L_{\infty}} = \max _I | \texttt{src1} (I)|}{if \(\texttt{normType} = \texttt{NORM_INF}\) }
157-
{ \| \texttt{src1} \| _{L_1} = \sum _I | \texttt{src1} (I)|}{if \(\texttt{normType} = \texttt{NORM_L1}\) }
158-
{ \| \texttt{src1} \| _{L_2} = \sqrt{\sum_I \texttt{src1}(I)^2} }{if \(\texttt{normType} = \texttt{NORM_L2}\) }\f]
159-
160-
- Absolute norm for two arrays
161-
\f[norm = \forkthree{\|\texttt{src1}-\texttt{src2}\|_{L_{\infty}} = \max _I | \texttt{src1} (I) - \texttt{src2} (I)|}{if \(\texttt{normType} = \texttt{NORM_INF}\) }
162-
{ \| \texttt{src1} - \texttt{src2} \| _{L_1} = \sum _I | \texttt{src1} (I) - \texttt{src2} (I)|}{if \(\texttt{normType} = \texttt{NORM_L1}\) }
163-
{ \| \texttt{src1} - \texttt{src2} \| _{L_2} = \sqrt{\sum_I (\texttt{src1}(I) - \texttt{src2}(I))^2} }{if \(\texttt{normType} = \texttt{NORM_L2}\) }\f]
164-
165-
- Relative norm for two arrays
166-
\f[norm = \forkthree{\frac{\|\texttt{src1}-\texttt{src2}\|_{L_{\infty}} }{\|\texttt{src2}\|_{L_{\infty}} }}{if \(\texttt{normType} = \texttt{NORM_RELATIVE | NORM_INF}\) }
167-
{ \frac{\|\texttt{src1}-\texttt{src2}\|_{L_1} }{\|\texttt{src2}\|_{L_1}} }{if \(\texttt{normType} = \texttt{NORM_RELATIVE | NORM_L1}\) }
168-
{ \frac{\|\texttt{src1}-\texttt{src2}\|_{L_2} }{\|\texttt{src2}\|_{L_2}} }{if \(\texttt{normType} = \texttt{NORM_RELATIVE | NORM_L2}\) }\f]
169-
170-
*/
154+
//! norm types
171155
enum NormTypes { NORM_INF = 1,
172156
NORM_L1 = 2,
173157
NORM_L2 = 4,
174158
NORM_L2SQR = 5,
175159
NORM_HAMMING = 6,
176160
NORM_HAMMING2 = 7,
177-
NORM_TYPE_MASK = 7,
161+
#ifndef CV_DOXYGEN
162+
NORM_TYPE_MASK = 7,
163+
#endif
178164
NORM_RELATIVE = 8, //!< flag
179165
NORM_MINMAX = 32 //!< flag
180166
};

0 commit comments

Comments
 (0)