Skip to content

Commit 53e577c

Browse files
twistedfalltwistedfall
committed
Regen docs
1 parent fce49eb commit 53e577c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2556
-1567
lines changed

‎docs/alphamat.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pub mod alphamat {
44
//!
55
//! This module is dedicated to computing alpha matte of objects in images from a given input image and a greyscale trimap image that contains information about the foreground, background and unknown pixels. The unknown pixels are assumed to be a combination of foreground and background pixels. The algorithm uses a combination of multiple carefully defined pixels affinities to estimate the opacity of the foreground pixels in the unkown region.
66
//!
7-
//! The implementation is based on [aksoy2017designing](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_aksoy2017designing).
7+
//! The implementation is based on [aksoy2017designing](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_aksoy2017designing).
88
//!
99
//! This module was developed by Muskaan Kularia and Sunita Nayak as a project
1010
//! for Google Summer of Code 2019 (GSoC 19).

‎docs/aruco.rs

Lines changed: 61 additions & 18 deletions
Large diffs are not rendered by default.

‎docs/bgsegm.rs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -195,16 +195,16 @@ pub mod bgsegm {
195195

196196
/// Creates an instance of BackgroundSubtractorLSBP algorithm.
197197
///
198-
/// Background Subtraction using Local SVD Binary Pattern. More details about the algorithm can be found at [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016)
198+
/// Background Subtraction using Local SVD Binary Pattern. More details about the algorithm can be found at [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016)
199199
///
200200
/// ## Parameters
201201
/// * mc: Whether to use camera motion compensation.
202202
/// * nSamples: Number of samples to maintain at each point of the frame.
203203
/// * LSBPRadius: LSBP descriptor radius.
204-
/// * Tlower: Lower bound for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
205-
/// * Tupper: Upper bound for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
206-
/// * Tinc: Increase step for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
207-
/// * Tdec: Decrease step for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
204+
/// * Tlower: Lower bound for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
205+
/// * Tupper: Upper bound for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
206+
/// * Tinc: Increase step for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
207+
/// * Tdec: Decrease step for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
208208
/// * Rscale: Scale coefficient for threshold values.
209209
/// * Rincdec: Increase/Decrease step for threshold values.
210210
/// * noiseRemovalThresholdFacBG: Strength of the noise removal for background points.
@@ -239,16 +239,16 @@ pub mod bgsegm {
239239

240240
/// Creates an instance of BackgroundSubtractorLSBP algorithm.
241241
///
242-
/// Background Subtraction using Local SVD Binary Pattern. More details about the algorithm can be found at [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016)
242+
/// Background Subtraction using Local SVD Binary Pattern. More details about the algorithm can be found at [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016)
243243
///
244244
/// ## Parameters
245245
/// * mc: Whether to use camera motion compensation.
246246
/// * nSamples: Number of samples to maintain at each point of the frame.
247247
/// * LSBPRadius: LSBP descriptor radius.
248-
/// * Tlower: Lower bound for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
249-
/// * Tupper: Upper bound for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
250-
/// * Tinc: Increase step for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
251-
/// * Tdec: Decrease step for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
248+
/// * Tlower: Lower bound for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
249+
/// * Tupper: Upper bound for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
250+
/// * Tinc: Increase step for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
251+
/// * Tdec: Decrease step for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
252252
/// * Rscale: Scale coefficient for threshold values.
253253
/// * Rincdec: Increase/Decrease step for threshold values.
254254
/// * noiseRemovalThresholdFacBG: Strength of the noise removal for background points.
@@ -798,7 +798,7 @@ pub mod bgsegm {
798798

799799
}
800800

801-
/// Background Subtractor module based on the algorithm given in [Gold2012](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_Gold2012) .
801+
/// Background Subtractor module based on the algorithm given in [Gold2012](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_Gold2012) .
802802
///
803803
/// Takes a series of images and returns a sequence of mask (8UC1)
804804
/// images of the same size, where 255 indicates Foreground and 0 represents Background.
@@ -1026,7 +1026,7 @@ pub mod bgsegm {
10261026

10271027
}
10281028

1029-
/// Background Subtraction using Local SVD Binary Pattern. More details about the algorithm can be found at [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016)
1029+
/// Background Subtraction using Local SVD Binary Pattern. More details about the algorithm can be found at [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016)
10301030
pub struct BackgroundSubtractorLSBP {
10311031
ptr: *mut c_void
10321032
}
@@ -1266,7 +1266,7 @@ pub mod bgsegm {
12661266

12671267
/// Gaussian Mixture-based Background/Foreground Segmentation Algorithm.
12681268
///
1269-
/// The class implements the algorithm described in [KB2001](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_KB2001) .
1269+
/// The class implements the algorithm described in [KB2001](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_KB2001) .
12701270
pub struct BackgroundSubtractorMOG {
12711271
ptr: *mut c_void
12721272
}

‎docs/bioinspired.rs

Lines changed: 2 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1009,59 +1009,11 @@ pub mod bioinspired {
10091009
/// Here is the default configuration file of the retina module. It gives results such as the first
10101010
/// retina output shown on the top of this page.
10111011
///
1012-
/// ```C++
1013-
/// <?xml version="1.0"?>
1014-
/// <opencv_storage>
1015-
/// <OPLandIPLparvo>
1016-
/// <colorMode>1</colorMode>
1017-
/// <normaliseOutput>1</normaliseOutput>
1018-
/// <photoreceptorsLocalAdaptationSensitivity>7.5e-01</photoreceptorsLocalAdaptationSensitivity>
1019-
/// <photoreceptorsTemporalConstant>9.0e-01</photoreceptorsTemporalConstant>
1020-
/// <photoreceptorsSpatialConstant>5.3e-01</photoreceptorsSpatialConstant>
1021-
/// <horizontalCellsGain>0.01</horizontalCellsGain>
1022-
/// <hcellsTemporalConstant>0.5</hcellsTemporalConstant>
1023-
/// <hcellsSpatialConstant>7.</hcellsSpatialConstant>
1024-
/// <ganglionCellsSensitivity>7.5e-01</ganglionCellsSensitivity></OPLandIPLparvo>
1025-
/// <IPLmagno>
1026-
/// <normaliseOutput>1</normaliseOutput>
1027-
/// <parasolCells_beta>0.</parasolCells_beta>
1028-
/// <parasolCells_tau>0.</parasolCells_tau>
1029-
/// <parasolCells_k>7.</parasolCells_k>
1030-
/// <amacrinCellsTemporalCutFrequency>2.0e+00</amacrinCellsTemporalCutFrequency>
1031-
/// <V0CompressionParameter>9.5e-01</V0CompressionParameter>
1032-
/// <localAdaptintegration_tau>0.</localAdaptintegration_tau>
1033-
/// <localAdaptintegration_k>7.</localAdaptintegration_k></IPLmagno>
1034-
/// </opencv_storage>
1035-
/// ```
1036-
///
1012+
/// @include default_retina_config.xml
10371013
///
10381014
/// Here is the 'realistic" setup used to obtain the second retina output shown on the top of this page.
10391015
///
1040-
/// ```C++
1041-
/// <?xml version="1.0"?>
1042-
/// <opencv_storage>
1043-
/// <OPLandIPLparvo>
1044-
/// <colorMode>1</colorMode>
1045-
/// <normaliseOutput>1</normaliseOutput>
1046-
/// <photoreceptorsLocalAdaptationSensitivity>8.9e-01</photoreceptorsLocalAdaptationSensitivity>
1047-
/// <photoreceptorsTemporalConstant>9.0e-01</photoreceptorsTemporalConstant>
1048-
/// <photoreceptorsSpatialConstant>5.3e-01</photoreceptorsSpatialConstant>
1049-
/// <horizontalCellsGain>0.3</horizontalCellsGain>
1050-
/// <hcellsTemporalConstant>0.5</hcellsTemporalConstant>
1051-
/// <hcellsSpatialConstant>7.</hcellsSpatialConstant>
1052-
/// <ganglionCellsSensitivity>8.9e-01</ganglionCellsSensitivity></OPLandIPLparvo>
1053-
/// <IPLmagno>
1054-
/// <normaliseOutput>1</normaliseOutput>
1055-
/// <parasolCells_beta>0.</parasolCells_beta>
1056-
/// <parasolCells_tau>0.</parasolCells_tau>
1057-
/// <parasolCells_k>7.</parasolCells_k>
1058-
/// <amacrinCellsTemporalCutFrequency>2.0e+00</amacrinCellsTemporalCutFrequency>
1059-
/// <V0CompressionParameter>9.5e-01</V0CompressionParameter>
1060-
/// <localAdaptintegration_tau>0.</localAdaptintegration_tau>
1061-
/// <localAdaptintegration_k>7.</localAdaptintegration_k></IPLmagno>
1062-
/// </opencv_storage>
1063-
/// ```
1064-
///
1016+
/// @include realistic_retina_config.xml
10651017
pub struct RetinaParameters {
10661018
ptr: *mut c_void
10671019
}

0 commit comments

Comments
 (0)