Skip to content

Commit

Permalink
Regen docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@twistedfall
twistedfall committed Jul 22, 2024
1 parent ed9a077 commit 38bc4e7
Show file tree
Hide file tree
Showing 52 changed files with 2,556 additions and 1,567 deletions.
2 changes: 1 addition & 1 deletion docs/alphamat.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pub mod alphamat {
//!
//! 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.
//!
//! The implementation is based on [aksoy2017designing](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_aksoy2017designing).
//! The implementation is based on [aksoy2017designing](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_aksoy2017designing).
//!
//! This module was developed by Muskaan Kularia and Sunita Nayak as a project
//! for Google Summer of Code 2019 (GSoC 19).
Expand Down
79 changes: 61 additions & 18 deletions docs/aruco.rs
View file

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions docs/bgsegm.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,16 +195,16 @@ pub mod bgsegm {

/// Creates an instance of BackgroundSubtractorLSBP algorithm.
///
/// 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)
/// 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)
///
/// ## Parameters
/// * mc: Whether to use camera motion compensation.
/// * nSamples: Number of samples to maintain at each point of the frame.
/// * LSBPRadius: LSBP descriptor radius.
/// * Tlower: Lower bound for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tupper: Upper bound for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tinc: Increase step for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tdec: Decrease step for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tlower: Lower bound for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tupper: Upper bound for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tinc: Increase step for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tdec: Decrease step for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Rscale: Scale coefficient for threshold values.
/// * Rincdec: Increase/Decrease step for threshold values.
/// * noiseRemovalThresholdFacBG: Strength of the noise removal for background points.
Expand Down Expand Up @@ -239,16 +239,16 @@ pub mod bgsegm {

/// Creates an instance of BackgroundSubtractorLSBP algorithm.
///
/// 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)
/// 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)
///
/// ## Parameters
/// * mc: Whether to use camera motion compensation.
/// * nSamples: Number of samples to maintain at each point of the frame.
/// * LSBPRadius: LSBP descriptor radius.
/// * Tlower: Lower bound for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tupper: Upper bound for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tinc: Increase step for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tdec: Decrease step for T-values. See [LGuo2016](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tlower: Lower bound for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tupper: Upper bound for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tinc: Increase step for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Tdec: Decrease step for T-values. See [LGuo2016](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_LGuo2016) for details.
/// * Rscale: Scale coefficient for threshold values.
/// * Rincdec: Increase/Decrease step for threshold values.
/// * noiseRemovalThresholdFacBG: Strength of the noise removal for background points.
Expand Down Expand Up @@ -798,7 +798,7 @@ pub mod bgsegm {

}

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

}

/// 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)
/// 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)
pub struct BackgroundSubtractorLSBP {
ptr: *mut c_void
}
Expand Down Expand Up @@ -1266,7 +1266,7 @@ pub mod bgsegm {

/// Gaussian Mixture-based Background/Foreground Segmentation Algorithm.
///
/// The class implements the algorithm described in [KB2001](https://docs.opencv.org/4.9.0/d0/de3/citelist.html#CITEREF_KB2001) .
/// The class implements the algorithm described in [KB2001](https://docs.opencv.org/4.10.0/d0/de3/citelist.html#CITEREF_KB2001) .
pub struct BackgroundSubtractorMOG {
ptr: *mut c_void
}
Expand Down
52 changes: 2 additions & 50 deletions docs/bioinspired.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1009,59 +1009,11 @@ pub mod bioinspired {
/// Here is the default configuration file of the retina module. It gives results such as the first
/// retina output shown on the top of this page.
///
/// ```C++
/// <?xml version="1.0"?>
/// <opencv_storage>
/// <OPLandIPLparvo>
/// <colorMode>1</colorMode>
/// <normaliseOutput>1</normaliseOutput>
/// <photoreceptorsLocalAdaptationSensitivity>7.5e-01</photoreceptorsLocalAdaptationSensitivity>
/// <photoreceptorsTemporalConstant>9.0e-01</photoreceptorsTemporalConstant>
/// <photoreceptorsSpatialConstant>5.3e-01</photoreceptorsSpatialConstant>
/// <horizontalCellsGain>0.01</horizontalCellsGain>
/// <hcellsTemporalConstant>0.5</hcellsTemporalConstant>
/// <hcellsSpatialConstant>7.</hcellsSpatialConstant>
/// <ganglionCellsSensitivity>7.5e-01</ganglionCellsSensitivity></OPLandIPLparvo>
/// <IPLmagno>
/// <normaliseOutput>1</normaliseOutput>
/// <parasolCells_beta>0.</parasolCells_beta>
/// <parasolCells_tau>0.</parasolCells_tau>
/// <parasolCells_k>7.</parasolCells_k>
/// <amacrinCellsTemporalCutFrequency>2.0e+00</amacrinCellsTemporalCutFrequency>
/// <V0CompressionParameter>9.5e-01</V0CompressionParameter>
/// <localAdaptintegration_tau>0.</localAdaptintegration_tau>
/// <localAdaptintegration_k>7.</localAdaptintegration_k></IPLmagno>
/// </opencv_storage>
/// ```
///
/// @include default_retina_config.xml
///
/// Here is the 'realistic" setup used to obtain the second retina output shown on the top of this page.
///
/// ```C++
/// <?xml version="1.0"?>
/// <opencv_storage>
/// <OPLandIPLparvo>
/// <colorMode>1</colorMode>
/// <normaliseOutput>1</normaliseOutput>
/// <photoreceptorsLocalAdaptationSensitivity>8.9e-01</photoreceptorsLocalAdaptationSensitivity>
/// <photoreceptorsTemporalConstant>9.0e-01</photoreceptorsTemporalConstant>
/// <photoreceptorsSpatialConstant>5.3e-01</photoreceptorsSpatialConstant>
/// <horizontalCellsGain>0.3</horizontalCellsGain>
/// <hcellsTemporalConstant>0.5</hcellsTemporalConstant>
/// <hcellsSpatialConstant>7.</hcellsSpatialConstant>
/// <ganglionCellsSensitivity>8.9e-01</ganglionCellsSensitivity></OPLandIPLparvo>
/// <IPLmagno>
/// <normaliseOutput>1</normaliseOutput>
/// <parasolCells_beta>0.</parasolCells_beta>
/// <parasolCells_tau>0.</parasolCells_tau>
/// <parasolCells_k>7.</parasolCells_k>
/// <amacrinCellsTemporalCutFrequency>2.0e+00</amacrinCellsTemporalCutFrequency>
/// <V0CompressionParameter>9.5e-01</V0CompressionParameter>
/// <localAdaptintegration_tau>0.</localAdaptintegration_tau>
/// <localAdaptintegration_k>7.</localAdaptintegration_k></IPLmagno>
/// </opencv_storage>
/// ```
///
/// @include realistic_retina_config.xml
pub struct RetinaParameters {
ptr: *mut c_void
}
Expand Down
Loading

0 comments on commit 38bc4e7

Please sign in to comment.