Skip to content

Commit 8f3a61b

Browse files
mshabuninmshabunin
authored
Merge pull request #3687 from mshabunin:doc-upgrade-5.x
Documentation transition to fresh Doxygen (5.x) #3687 Port of #3638 Merge with opencv/opencv#25161 CI part: opencv/ci-gha-workflow#162
1 parent 6f68a4e commit 8f3a61b

File tree

32 files changed

+221
-233
lines changed

32 files changed

+221
-233
lines changed

‎modules/bioinspired/include/opencv2/bioinspired/retina.hpp

+3-48
Original file line numberDiff line numberDiff line change
@@ -94,57 +94,12 @@ enum {
9494
Here is the default configuration file of the retina module. It gives results such as the first
9595
retina output shown on the top of this page.
9696
97-
@code{xml}
98-
<?xml version="1.0"?>
99-
<opencv_storage>
100-
<OPLandIPLparvo>
101-
<colorMode>1</colorMode>
102-
<normaliseOutput>1</normaliseOutput>
103-
<photoreceptorsLocalAdaptationSensitivity>7.5e-01</photoreceptorsLocalAdaptationSensitivity>
104-
<photoreceptorsTemporalConstant>9.0e-01</photoreceptorsTemporalConstant>
105-
<photoreceptorsSpatialConstant>5.3e-01</photoreceptorsSpatialConstant>
106-
<horizontalCellsGain>0.01</horizontalCellsGain>
107-
<hcellsTemporalConstant>0.5</hcellsTemporalConstant>
108-
<hcellsSpatialConstant>7.</hcellsSpatialConstant>
109-
<ganglionCellsSensitivity>7.5e-01</ganglionCellsSensitivity></OPLandIPLparvo>
110-
<IPLmagno>
111-
<normaliseOutput>1</normaliseOutput>
112-
<parasolCells_beta>0.</parasolCells_beta>
113-
<parasolCells_tau>0.</parasolCells_tau>
114-
<parasolCells_k>7.</parasolCells_k>
115-
<amacrinCellsTemporalCutFrequency>2.0e+00</amacrinCellsTemporalCutFrequency>
116-
<V0CompressionParameter>9.5e-01</V0CompressionParameter>
117-
<localAdaptintegration_tau>0.</localAdaptintegration_tau>
118-
<localAdaptintegration_k>7.</localAdaptintegration_k></IPLmagno>
119-
</opencv_storage>
120-
@endcode
97+
@include default_retina_config.xml
12198
12299
Here is the 'realistic" setup used to obtain the second retina output shown on the top of this page.
123100
124-
@code{xml}
125-
<?xml version="1.0"?>
126-
<opencv_storage>
127-
<OPLandIPLparvo>
128-
<colorMode>1</colorMode>
129-
<normaliseOutput>1</normaliseOutput>
130-
<photoreceptorsLocalAdaptationSensitivity>8.9e-01</photoreceptorsLocalAdaptationSensitivity>
131-
<photoreceptorsTemporalConstant>9.0e-01</photoreceptorsTemporalConstant>
132-
<photoreceptorsSpatialConstant>5.3e-01</photoreceptorsSpatialConstant>
133-
<horizontalCellsGain>0.3</horizontalCellsGain>
134-
<hcellsTemporalConstant>0.5</hcellsTemporalConstant>
135-
<hcellsSpatialConstant>7.</hcellsSpatialConstant>
136-
<ganglionCellsSensitivity>8.9e-01</ganglionCellsSensitivity></OPLandIPLparvo>
137-
<IPLmagno>
138-
<normaliseOutput>1</normaliseOutput>
139-
<parasolCells_beta>0.</parasolCells_beta>
140-
<parasolCells_tau>0.</parasolCells_tau>
141-
<parasolCells_k>7.</parasolCells_k>
142-
<amacrinCellsTemporalCutFrequency>2.0e+00</amacrinCellsTemporalCutFrequency>
143-
<V0CompressionParameter>9.5e-01</V0CompressionParameter>
144-
<localAdaptintegration_tau>0.</localAdaptintegration_tau>
145-
<localAdaptintegration_k>7.</localAdaptintegration_k></IPLmagno>
146-
</opencv_storage>
147-
@endcode
101+
@include realistic_retina_config.xml
102+
148103
*/
149104
struct RetinaParameters{
150105
//! Outer Plexiform Layer (OPL) and Inner Plexiform Layer Parvocellular (IplParvo) parameters

‎modules/bioinspired/samples/default_retina_config.xml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?xml version="1.0"?>
2+
<opencv_storage>
3+
<OPLandIPLparvo>
4+
<colorMode>1</colorMode>
5+
<normaliseOutput>1</normaliseOutput>
6+
<photoreceptorsLocalAdaptationSensitivity>7.5e-01</photoreceptorsLocalAdaptationSensitivity>
7+
<photoreceptorsTemporalConstant>9.0e-01</photoreceptorsTemporalConstant>
8+
<photoreceptorsSpatialConstant>5.3e-01</photoreceptorsSpatialConstant>
9+
<horizontalCellsGain>0.01</horizontalCellsGain>
10+
<hcellsTemporalConstant>0.5</hcellsTemporalConstant>
11+
<hcellsSpatialConstant>7.</hcellsSpatialConstant>
12+
<ganglionCellsSensitivity>7.5e-01</ganglionCellsSensitivity>
13+
</OPLandIPLparvo>
14+
<IPLmagno>
15+
<normaliseOutput>1</normaliseOutput>
16+
<parasolCells_beta>0.</parasolCells_beta>
17+
<parasolCells_tau>0.</parasolCells_tau>
18+
<parasolCells_k>7.</parasolCells_k>
19+
<amacrinCellsTemporalCutFrequency>2.0e+00</amacrinCellsTemporalCutFrequency>
20+
<V0CompressionParameter>9.5e-01</V0CompressionParameter>
21+
<localAdaptintegration_tau>0.</localAdaptintegration_tau>
22+
<localAdaptintegration_k>7.</localAdaptintegration_k>
23+
</IPLmagno>
24+
</opencv_storage>

‎modules/bioinspired/samples/realistic_retina_config.xml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?xml version="1.0"?>
2+
<opencv_storage>
3+
<OPLandIPLparvo>
4+
<colorMode>1</colorMode>
5+
<normaliseOutput>1</normaliseOutput>
6+
<photoreceptorsLocalAdaptationSensitivity>8.9e-01</photoreceptorsLocalAdaptationSensitivity>
7+
<photoreceptorsTemporalConstant>9.0e-01</photoreceptorsTemporalConstant>
8+
<photoreceptorsSpatialConstant>5.3e-01</photoreceptorsSpatialConstant>
9+
<horizontalCellsGain>0.3</horizontalCellsGain>
10+
<hcellsTemporalConstant>0.5</hcellsTemporalConstant>
11+
<hcellsSpatialConstant>7.</hcellsSpatialConstant>
12+
<ganglionCellsSensitivity>8.9e-01</ganglionCellsSensitivity>
13+
</OPLandIPLparvo>
14+
<IPLmagno>
15+
<normaliseOutput>1</normaliseOutput>
16+
<parasolCells_beta>0.</parasolCells_beta>
17+
<parasolCells_tau>0.</parasolCells_tau>
18+
<parasolCells_k>7.</parasolCells_k>
19+
<amacrinCellsTemporalCutFrequency>2.0e+00</amacrinCellsTemporalCutFrequency>
20+
<V0CompressionParameter>9.5e-01</V0CompressionParameter>
21+
<localAdaptintegration_tau>0.</localAdaptintegration_tau>
22+
<localAdaptintegration_k>7.</localAdaptintegration_k>
23+
</IPLmagno>
24+
</opencv_storage>

‎modules/bioinspired/tutorials/retina_model/retina_model.markdown

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Retina and real-world vision {#tutorial_bioinspired_retina_model}
22
=============================================================
33

4+
@tableofcontents
5+
46
Goal
57
----
68

@@ -382,7 +384,7 @@ need to know if mean luminance information is required or not. If not, the the r
382384
significantly reduce its energy thus giving more visibility to higher spatial frequency details.
383385

384386

385-
#### Basic parameters
387+
## Basic parameters
386388

387389
The simplest parameters are as follows :
388390

@@ -397,7 +399,7 @@ processing. You can expect much faster processing using gray levels : it would r
397399
product per pixel for all of the retina processes and it has recently been parallelized for multicore
398400
architectures.
399401

400-
#### Photo-receptors parameters
402+
## Photo-receptors parameters
401403

402404
The following parameters act on the entry point of the retina - photo-receptors - and has impact on all
403405
of the following processes. These sensors are low pass spatio-temporal filters that smooth temporal and
@@ -421,7 +423,7 @@ and high frequency noise canceling.
421423
A good compromise for color images is a 0.53 value since such choice won't affect too much the color spectrum.
422424
Higher values would lead to gray and blurred output images.
423425

424-
#### Horizontal cells parameters
426+
## Horizontal cells parameters
425427

426428
This parameter set tunes the neural network connected to the photo-receptors, the horizontal cells.
427429
It modulates photo-receptors sensitivity and completes the processing for final spectral whitening
@@ -446,7 +448,7 @@ It modulates photo-receptors sensitivity and completes the processing for final
446448
and luminance is already partly enhanced. The following parameters act on the last processing stages
447449
of the two outing retina signals.
448450

449-
#### Parvo (details channel) dedicated parameter
451+
## Parvo (details channel) dedicated parameter
450452

451453
- **ganglionCellsSensitivity** specifies the strength of the final local adaptation occurring at
452454
the output of this details' dedicated channel. Parameter values remain between 0 and 1. Low value
@@ -455,7 +457,7 @@ of the two outing retina signals.
455457
**Note :** this parameter can correct eventual burned images by favoring low energetic details of
456458
the visual scene, even in bright areas.
457459

458-
#### IPL Magno (motion/transient channel) parameters
460+
## IPL Magno (motion/transient channel) parameters
459461

460462
Once image's information are cleaned, this channel acts as a high pass temporal filter that
461463
selects only the signals related to transient signals (events, motion, etc.). A low pass spatial filter

‎modules/cannops/include/opencv2/cann.hpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
#include "opencv2/core.hpp"
99

1010
/**
11-
@defgroup cann Ascend-accelerated Computer Vision
11+
@defgroup cannops Ascend-accelerated Computer Vision
1212
@{
1313
@defgroup canncore Core part
1414
@{
1515
@defgroup cann_struct Data Structures
16-
@defgroup cann_init Initializeation and Information
16+
@defgroup cann_init Initialization and Information
1717
@}
1818
@}
1919
*/

‎modules/cannops/include/opencv2/cann_interface.hpp

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ namespace cann
1313
{
1414

1515
/**
16-
@addtogroup cann
16+
@addtogroup cannops
1717
@{
18-
@defgroup cannops Operations for Ascend Backend.
18+
@defgroup cannops_ops Operations for Ascend Backend.
1919
@{
2020
@defgroup cannops_elem Per-element Operations
2121
@defgroup cannops_core Core Operations on Matrices

‎modules/cudaimgproc/include/opencv2/cudaimgproc.hpp

-1
Original file line numberDiff line numberDiff line change
@@ -844,7 +844,6 @@ cv::Moments cvMoments = convertSpatialMoments<float>(spatialMoments, order);
844844
```
845845
846846
see the \a CUDA_TEST_P(Moments, Async) test inside opencv_contrib_source_code/modules/cudaimgproc/test/test_moments.cpp for an example.
847-
@returns cv::Moments.
848847
@sa cuda::moments, cuda::convertSpatialMoments, cuda::numMoments, cuda::MomentsOrder
849848
*/
850849
CV_EXPORTS_W void spatialMoments(InputArray src, OutputArray moments, const bool binaryImage = false, const MomentsOrder order = MomentsOrder::THIRD_ORDER_MOMENTS, const int momentsType = CV_64F, Stream& stream = Stream::Null());

‎modules/dnn_superres/tutorials/benchmark/sr_benchmark.markdown

+9-20
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,9 @@ Explanation
5050
Benchmarking results
5151
-----------
5252

53-
Dataset benchmarking
54-
----
55-
56-
###General100 dataset
57-
58-
<center>
53+
## General100 dataset
5954

60-
#####2x scaling factor
55+
### 2x scaling factor
6156

6257

6358
| | Avg inference time in sec (CPU)| Avg PSNR | Avg SSIM |
@@ -70,7 +65,7 @@ Dataset benchmarking
7065
| Nearest neighbor | 0.000114 | 29.1665 | 0.9049 |
7166
| Lanczos | 0.001094 | 32.4687 | 0.9327 |
7267

73-
#####3x scaling factor
68+
### 3x scaling factor
7469

7570
| | Avg inference time in sec (CPU)| Avg PSNR | Avg SSIM |
7671
| ------------- |:-------------------:| ---------:|--------:|
@@ -83,7 +78,7 @@ Dataset benchmarking
8378
| Lanczos | 0.001012 |25.9115 |0.8706 |
8479

8580

86-
#####4x scaling factor
81+
### 4x scaling factor
8782

8883
| | Avg inference time in sec (CPU)| Avg PSNR | Avg SSIM |
8984
| ------------- |:-------------------:| ---------:|--------:|
@@ -96,14 +91,10 @@ Dataset benchmarking
9691
| Lanczos | 0.001012 |25.9115 |0.8706 |
9792

9893

99-
</center>
10094

101-
Images
102-
----
103-
104-
<center>
95+
## Images
10596

106-
####2x scaling factor
97+
### 2x scaling factor
10798

10899
|Set5: butterfly.png | size: 256x256 | ||
109100
|:-------------:|:-------------------:|:-------------:|:----:|
@@ -112,7 +103,7 @@ Images
112103
![ESPCN](images/espcn_butterfly.jpg)| ![FSRCNN](images/fsrcnn_butterfly.jpg) | ![LapSRN](images/lapsrn_butterfly.jpg) | ![EDSR](images/edsr_butterfly.jpg)
113104
|29.0341 / 0.9354 / **0.004157**| 29.0077 / 0.9345 / 0.006325 | 27.8212 / 0.9230 / 0.037937 | **30.0347** / **0.9453** / 2.077280 |
114105

115-
####3x scaling factor
106+
### 3x scaling factor
116107

117108
|Urban100: img_001.png | size: 1024x644 | ||
118109
|:-------------:|:-------------------:|:-------------:|:----:|
@@ -122,7 +113,7 @@ Images
122113
|28.0118 / 0.8588 / **0.030748**| 28.0184 / 0.8597 / 0.094173 | | **30.5671** / **0.9019** / 9.517580 |
123114

124115

125-
####4x scaling factor
116+
### 4x scaling factor
126117

127118
|Set14: comic.png | size: 250x361 | ||
128119
|:-------------:|:-------------------:|:-------------:|:----:|
@@ -131,13 +122,11 @@ Images
131122
|![ESPCN](images/espcn_comic.jpg)| ![FSRCNN](images/fsrcnn_comic.jpg) | ![LapSRN](images/lapsrn_comic.jpg) | ![EDSR](images/edsr_comic.jpg)
132123
|20.0417 / 0.6302 / **0.001894**| 20.0885 / 0.6384 / 0.002103 | 20.0676 / 0.6339 / 0.061640 | **20.5233** / **0.6901** / 0.665876 |
133124

134-
####8x scaling factor
125+
### 8x scaling factor
135126

136127
|Div2K: 0006.png | size: 1356x2040 | |
137128
|:-------------:|:-------------------:|:-------------:|
138129
|![Original](images/orig_div2k.jpg)|![Bicubic interpolation](images/bicubic_div2k.jpg)|![Nearest neighbor interpolation](images/nearest_div2k.jpg)|
139130
|PSRN / SSIM / Speed (CPU)| 26.3139 / **0.8033** / 0.001107| 23.8291 / 0.7340 / **0.000611** |
140131
|![Lanczos interpolation](images/lanczos_div2k.jpg)| ![LapSRN](images/lapsrn_div2k.jpg) | |
141132
|26.1565 / 0.7962 / 0.004782| **26.7046** / 0.7987 / 2.274290 | |
142-
143-
</center>

‎modules/face/include/opencv2/face/facemark.hpp

+3-6
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,15 @@ Mentor: Delia Passalacqua
1212
#ifndef __OPENCV_FACELANDMARK_HPP__
1313
#define __OPENCV_FACELANDMARK_HPP__
1414

15-
/**
16-
@defgroup face Face Analysis
17-
- @ref tutorial_table_of_content_facemark
18-
- The Facemark API
19-
*/
20-
2115
#include "opencv2/core.hpp"
2216
#include <vector>
2317

2418

2519
namespace cv {
2620
namespace face {
2721

22+
//! @addtogroup face
23+
//! @{
2824

2925
/** @brief Abstract base class for all facemark models
3026
@@ -88,6 +84,7 @@ CV_EXPORTS_W Ptr<Facemark> createFacemarkLBF();
8884
//! construct a Kazemi facemark detector
8985
CV_EXPORTS_W Ptr<Facemark> createFacemarkKazemi();
9086

87+
//! @}
9188

9289
} // face
9390
} // cv

‎modules/face/include/opencv2/face/facemark_train.hpp

-6
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,6 @@ Mentor: Delia Passalacqua
1212
#ifndef __OPENCV_FACELANDMARKTRAIN_HPP__
1313
#define __OPENCV_FACELANDMARKTRAIN_HPP__
1414

15-
/**
16-
@defgroup face Face Analysis
17-
- @ref tutorial_table_of_content_facemark
18-
- The Facemark API
19-
*/
20-
2115
#include "opencv2/face/facemark.hpp"
2216
#include "opencv2/objdetect.hpp"
2317
#include <vector>

‎modules/face/tutorials/face_landmark/face_landmark_trainer.markdown

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![](images/2.jpg)
1+
![](face_landmark/images/2.jpg)
22

33
Training face landmark detector{#tutorial_face_training_face_landmark_detector}
44
==============================
@@ -21,7 +21,7 @@ The above format is similar to HELEN dataset which is used for training the mode
2121
./sample_train_landmark_detector -annotations=/home/sukhad/Downloads/code/trainset/ -config=config.xml -face_cascade=lbpcascadefrontalface.xml -model=trained_model.dat -width=460 -height=460
2222
```
2323

24-
### Description of command parameters
24+
## Description of command parameters
2525

2626
> * **annotations** a : (REQUIRED) Path to annotations txt file [example - /data/annotations.txt]
2727
> * **config** c : (REQUIRED) Path to configuration xml file containing parameters for training.[ example - /data/config.xml]
@@ -30,7 +30,7 @@ The above format is similar to HELEN dataset which is used for training the mode
3030
> * **height** h : (OPTIONAL) The height which you want all images to get to scale the annotations. Large images are slow to process [default = 460]
3131
> * **face_cascade** f (REQUIRED) Path to the face cascade xml file which you want to use as a detector.
3232
33-
### Description of training parameters
33+
## Description of training parameters
3434

3535

3636
The configuration file described above which is used while training contains the training parameters which are required for training.
@@ -49,10 +49,10 @@ The configuration file described above which is used while training contains the
4949

5050
To get more detailed description about the training parameters you can refer to the [Research paper](https://pdfs.semanticscholar.org/d78b/6a5b0dcaa81b1faea5fb0000045a62513567.pdf).
5151

52-
### Understanding code
52+
## Understanding code
5353

5454

55-
![](images/3.jpg)
55+
![](face_landmark/images/3.jpg)
5656

5757

5858
Jumping directly to the code :
@@ -165,13 +165,13 @@ In the above function scale is passed to scale all images and the corresponding
165165
images can be reduced as it takes greater time to process large images.
166166
This call to the train function trains the model and stores the trained model file with the given
167167
filename specified.As the training starts successfully you will see something like this :
168-
![](images/train1.png)
168+
![](face_landmark/images/train1.png)
169169

170170

171171
**The error rate on trained images depends on the number of images used for training used as follows :**
172172

173-
![](images/train.png)
173+
![](face_landmark/images/train.png)
174174

175175
**The error rate on test images depends on the number of images used for training used as follows :**
176176

177-
![](images/test.png)
177+
![](face_landmark/images/test.png)

0 commit comments

Comments
 (0)