Added all *.cpp samples reference to the 2.4.6 documentation as discussed in feature...
authorStevenPuttemans <steven.puttemans@lessius.eu>
Mon, 29 Jul 2013 13:51:16 +0000 (15:51 +0200)
committerStevenPuttemans <steven.puttemans@lessius.eu>
Wed, 31 Jul 2013 09:20:05 +0000 (11:20 +0200)
- Used lunix style slashes - works on most systems
- Removed all trailing whitespaces

30 files changed:
modules/calib3d/doc/camera_calibration_and_3d_reconstruction.rst
modules/contrib/doc/facerec/facerec_api.rst
modules/contrib/doc/openfabmap.rst
modules/contrib/doc/retina/index.rst
modules/core/doc/basic_structures.rst
modules/core/doc/clustering.rst
modules/core/doc/drawing_functions.rst
modules/core/doc/operations_on_arrays.rst
modules/core/doc/xml_yaml_persistence.rst
modules/features2d/doc/common_interfaces_of_descriptor_extractors.rst
modules/features2d/doc/common_interfaces_of_descriptor_matchers.rst
modules/features2d/doc/common_interfaces_of_feature_detectors.rst
modules/features2d/doc/common_interfaces_of_generic_descriptor_matchers.rst
modules/features2d/doc/feature_detection_and_description.rst
modules/features2d/doc/object_categorization.rst
modules/gpu/doc/object_detection.rst
modules/highgui/doc/reading_and_writing_images_and_video.rst
modules/highgui/doc/user_interface.rst
modules/imgproc/doc/feature_detection.rst
modules/imgproc/doc/filtering.rst
modules/imgproc/doc/geometric_transformations.rst
modules/imgproc/doc/histograms.rst
modules/imgproc/doc/miscellaneous_transformations.rst
modules/imgproc/doc/structural_analysis_and_shape_descriptors.rst
modules/legacy/doc/expectation_maximization.rst
modules/legacy/doc/feature_detection_and_description.rst
modules/nonfree/doc/feature_detection.rst
modules/photo/doc/inpainting.rst
modules/stitching/doc/high_level.rst
modules/video/doc/motion_analysis_and_object_tracking.rst

index b90fba7e1275ec8ac888d7ecccf19de126a50f95..886ac6f1d52111887aba09ba0779dc699394df4e 100644 (file)
@@ -105,7 +105,14 @@ The functions below use the above model to do the following:
 
  * Estimate the relative position and orientation of the stereo camera "heads" and compute the *rectification* transformation that makes the camera optical axes parallel.
 
+.. Sample code::
 
+   * : A calibration sample for 3 cameras in horizontal position can be found at opencv_source_code/samples/cpp/3calibration.cpp
+   * : A calibration sample based on a sequence of images can be found at opencv_source_code/samples/cpp/calibration.cpp
+   * : A calibration sample in order to do 3D reconstruction can be found at opencv_source_code/samples/cpp/build3dmodel.cpp
+   * : A calibration sample of an artificially generated camera and chessboard patterns can be found at opencv_source_code/samples/cpp/calibration_artificial.cpp
+   * : A calibration example on stereo calibration can be found at opencv_source_code/samples/cpp/stereo_calib.cpp
+   * : A calibration example on stereo matching can be found at opencv_source_code/samples/cpp/stereo_match.cpp
 
 calibrateCamera
 ---------------
@@ -766,6 +773,9 @@ Homography matrix is determined up to a scale. Thus, it is normalized so that
     :ocv:func:`warpPerspective`,
     :ocv:func:`perspectiveTransform`
 
+.. Sample code::
+
+   * : A example on calculating a homography for image matching can be found at opencv_source_code/samples/cpp/video_homography.cpp
 
 estimateAffine3D
 --------------------
index 8bea7070ae59e6aa3f8226e57a10d5fd6f250da1..af3901f72034d3e410f72a2f5f490232c315fc28 100644 (file)
@@ -3,6 +3,10 @@ FaceRecognizer
 
 .. highlight:: cpp
 
+.. Sample code::
+
+   * : An example using the FaceRecognizer class can be found at opencv_source_code/samples/cpp/facerec_demo.cpp
+
 FaceRecognizer
 --------------
 
index 2f2ad407459da89caa72527b54099a2225ffe4f4..bfcd9bcf0f29a8a1312ace33a9f940085d0fe6cf 100644 (file)
@@ -9,6 +9,10 @@ FAB-MAP is an approach to appearance-based place recognition. FAB-MAP compares i
 
 openFABMAP requires training data (e.g. a collection of images from a similar but not identical environment) to construct a visual vocabulary for the visual bag-of-words model, along with a Chow-Liu tree representation of feature likelihood and for use in the Sampled new place method (see below).
 
+.. Sample code::
+
+   * : An example using the openFABMAP package can be found at opencv_source_code/samples/cpp/fabmap_sample.cpp
+
 of2::FabMap
 --------------------
 
index a3a5bc82fce44e7e2eb525556a6c8ebca5289d75..6decb3955dd75b19f91bf628049357da6104e0bc 100644 (file)
@@ -63,6 +63,11 @@ The retina can be settled up with various parameters, by default, the retina can
     void activateContoursProcessing (const bool activate);
   };
 
+.. Sample code::
+
+   * : An example on retina tone mapping can be found at opencv_source_code/samples/cpp/OpenEXRimages_HighDynamicRange_Retina_toneMapping.cpp
+   * : An example on retina tone mapping on video input can be found at opencv_source_code/samples/cpp/OpenEXRimages_HighDynamicRange_Retina_toneMapping.cpp
+   * : A complete example illustrating the retina interface can be found at opencv_source_code/samples/cpp/retinaDemo.cpp
 
 Description
 +++++++++++
index 3705879228d17be91c7d1726962566198007df7c..44c36a4b1f2578c969444d3d6c2f4685ba27df4a 100644 (file)
@@ -803,6 +803,9 @@ Finally, there are STL-style iterators that are smart enough to skip gaps betwee
 
 The matrix iterators are random-access iterators, so they can be passed to any STL algorithm, including ``std::sort()`` .
 
+.. Sample code::
+
+   * : An example demonstrating the serial out capabilities of cv::Mat can be found at opencv_source_code/samples/cpp/cout_mat.cpp
 
 .. _MatrixExpressions:
 
index f58e99ce2cbbf7c159f38601017863f808621778..d770043f010fbe3ed456911972e525631bd9dc5e 100644 (file)
@@ -66,6 +66,10 @@ Basically, you can use only the core of the function, set the number of
 attempts to 1, initialize labels each time using a custom algorithm, pass them with the
 ( ``flags`` = ``KMEANS_USE_INITIAL_LABELS`` ) flag, and then choose the best (most-compact) clustering.
 
+.. Sample code::
+
+   * : An example on K-means clustering can be found at opencv_source_code/samples/cpp/kmeans.cpp
+
 partition
 -------------
 Splits an element set into equivalency classes.
index 342301db970244618abc889b215d87691d4437f5..f4df7eef7fc89351f384c137cb5f297597831f9c 100644 (file)
@@ -26,6 +26,10 @@ If a drawn figure is partially or completely outside the image, the drawing func
 
 .. note:: The functions do not support alpha-transparency when the target image is 4-channel. In this case, the ``color[3]`` is simply copied to the repainted pixels. Thus, if you want to paint semi-transparent shapes, you can paint them in a separate buffer and then blend it with the main image.
 
+.. Sample code::
+
+   * : An example on using variate drawing functions like line, rectangle, ... can be found at opencv_source_code/samples/cpp/drawing.cpp
+
 circle
 ----------
 Draws a circle.
index bd55993afe813bcf8544f291db32e074a2bda571..bc9de713bad3c94bfc4ff3335e825cc4d6f15785 100644 (file)
@@ -997,6 +997,9 @@ All of the above improvements have been implemented in :ocv:func:`matchTemplate`
 
 .. seealso:: :ocv:func:`dct` , :ocv:func:`getOptimalDFTSize` , :ocv:func:`mulSpectrums`, :ocv:func:`filter2D` , :ocv:func:`matchTemplate` , :ocv:func:`flip` , :ocv:func:`cartToPolar` , :ocv:func:`magnitude` , :ocv:func:`phase`
 
+.. Sample code::
+
+   * : An example using the discrete fourier transform can be found at opencv_source_code/samples/cpp/dft.cpp
 
 
 divide
@@ -2262,7 +2265,9 @@ The sample below is the function that takes two matrices. The first function sto
     :ocv:func:`dft`,
     :ocv:func:`dct`
 
+.. Sample code::
 
+   * : An example using PCA for dimensionality reduction while maintaining an amount of variance can be found at opencv_source_code/samples/cpp/pca.cpp
 
 PCA::PCA
 --------
index 42fa4016138b7a0be6a6e90e200a39526bc0e8fc..0628e8b0ed7e5d38484e0793860c0bb5e061837c 100644 (file)
@@ -91,6 +91,10 @@ Several things can be noted by looking at the sample code and the output:
  *
    In YAML (but not XML), mappings and sequences can be written in a compact Python-like inline form. In the sample above matrix elements, as well as each feature, including its lbp value, is stored in such inline form. To store a mapping/sequence in a compact form, put ":" after the opening character, e.g. use **"{:"** instead of **"{"** and **"[:"** instead of **"["**. When the data is written to XML, those extra ":" are ignored.
 
+.. Sample code::
+
+   * : A complete example using the FileStorage interface can be found at opencv_source_code/samples/cpp/filestorage.cpp
+
 
 Reading data from a file storage.
 ---------------------------------
index 63e56f67867f83f73f3e2d4b57ea2809dfc052b2..51870731dab1d2e00d1e371962a21621d862e7cd 100644 (file)
@@ -9,7 +9,10 @@ represented as vectors in a multidimensional space. All objects that implement t
 descriptor extractors inherit the
 :ocv:class:`DescriptorExtractor` interface.
 
+.. Sample code::
 
+   * : An example explaining keypoint extraction can be found at opencv_source_code/samples/cpp/descriptor_extractor_matcher.cpp
+   * : An example on descriptor evaluation can be found at opencv_source_code/samples/cpp/detector_descriptor_evaluation.cpp
 
 DescriptorExtractor
 -------------------
@@ -137,4 +140,6 @@ Strecha C., Fua P. *BRIEF: Binary Robust Independent Elementary Features* ,
         ...
     };
 
+.. Sample code:: 
 
+   * : A complete BRIEF extractor sample can be found at opencv_source_code/samples/cpp/brief_match_test.cpp
index d7e5eb4c29783909b30f623bb9d75291b3b21596..6272e88184f3a9b9585e7f4075068244cd287032 100644 (file)
@@ -9,6 +9,12 @@ that are represented as vectors in a multidimensional space. All objects that im
 descriptor matchers inherit the
 :ocv:class:`DescriptorMatcher` interface.
 
+.. Sample code::
+
+   * : An example explaining keypoint matching can be found at opencv_source_code/samples/cpp/descriptor_extractor_matcher.cpp
+   * : An example on descriptor matching evaluation can be found at opencv_source_code/samples/cpp/detector_descriptor_matcher_evaluation.cpp
+   * : An example on one to many image matching can be found at opencv_source_code/samples/cpp/matching_to_many_images.cpp
+
 DMatch
 ------
 .. ocv:struct:: DMatch
index 81c72d3a81daea9785ef94c08bb93d69c4ce1bbe..bd0bce5c1d32ab9ba61e4af8ba43d01f5aed0914 100644 (file)
@@ -8,6 +8,11 @@ between different algorithms solving the same problem. All objects that implemen
 inherit the
 :ocv:class:`FeatureDetector` interface.
 
+.. Sample code::
+
+   * : An example explaining keypoint detection can be found at opencv_source_code/samples/cpp/descriptor_extractor_matcher.cpp
+
+
 KeyPoint
 --------
 .. ocv:class:: KeyPoint
index a306c66067c4a0263b287d3322a92ca4577a69ba..b5e60dc59a13a2d596fedc624434dff6773f4ae5 100644 (file)
@@ -11,7 +11,11 @@ Every descriptor with the
 :ocv:class:`VectorDescriptorMatcher` ).
 There are descriptors such as the One-way descriptor and Ferns that have the ``GenericDescriptorMatcher`` interface implemented but do not support ``DescriptorExtractor``.
 
+.. Sample code::
 
+   * : An example explaining keypoint description can be found at opencv_source_code/samples/cpp/descriptor_extractor_matcher.cpp
+   * : An example on descriptor matching evaluation can be found at opencv_source_code/samples/cpp/detector_descriptor_matcher_evaluation.cpp
+   * : An example on one to many image matching can be found at opencv_source_code/samples/cpp/matching_to_many_images.cpp
 
 GenericDescriptorMatcher
 ------------------------
index 80a1de04a470cfe8efcdb6a37f877287995b8e7d..9690f883a72c9d64af6d8e410c2c4a0a760c06a6 100644 (file)
@@ -3,6 +3,10 @@ Feature Detection and Description
 
 .. highlight:: cpp
 
+.. Sample code::
+
+   * : An example explaining keypoint detection and description can be found at opencv_source_code/samples/cpp/descriptor_extractor_matcher.cpp
+
 FAST
 ----
 Detects corners using the FAST algorithm
@@ -158,6 +162,10 @@ Class implementing the FREAK (*Fast Retina Keypoint*) keypoint descriptor, descr
 
 .. [AOV12] A. Alahi, R. Ortiz, and P. Vandergheynst. FREAK: Fast Retina Keypoint. In IEEE Conference on Computer Vision and Pattern Recognition, 2012. CVPR 2012 Open Source Award Winner.
 
+.. Sample code::
+
+   * : An example on how to use the FREAK descriptor can be found at opencv_source_code/samples/cpp/freak_demo.cpp
+
 FREAK::FREAK
 ------------
 The FREAK constructor
index d7b34aff5fe0256b0f1cf0d8fe05f4410ac1d7c8..3212b6abdd5636dee3338e7c1296c16aac2d9b12 100644 (file)
@@ -5,6 +5,8 @@ Object Categorization
 
 This section describes approaches based on local 2D features and used to categorize objects.
 
+.. Sample code:: A complete Bag-Of-Words sample can be found at opencv_source_code/samples/cpp/bagofwords_classification.cpp
+
 BOWTrainer
 ----------
 .. ocv:class:: BOWTrainer
index 133660236ac0949e555ccac0ca7826fa45d2f5cb..c7986fa7a205fdcf9a748dcceda38712d266a349 100644 (file)
@@ -62,7 +62,9 @@ The class implements Histogram of Oriented Gradients ([Dalal2005]_) object detec
 
 Interfaces of all methods are kept similar to the ``CPU HOG`` descriptor and detector analogues as much as possible.
 
+.. Sample code::
 
+   * : An example applying the HOG descriptor for people detection can be found at opencv_source_code/samples/cpp/peopledetect.cpp
 
 gpu::HOGDescriptor::HOGDescriptor
 -------------------------------------
index d473bb49237c50c05e5108d9da772ba10458f1eb..3b96124b95da2581b4d6e01ab40715f8e25a5460 100644 (file)
@@ -224,6 +224,10 @@ The class provides C++ API for capturing video from cameras or for reading video
 
 .. note:: In C API the black-box structure ``CvCapture`` is used instead of ``VideoCapture``.
 
+.. Sample code::
+
+   * : A basic sample on using the VideoCapture interface can be found at opencv_source_code/samples/cpp/starter_video.cpp
+   * : Another basic video processing sample can be found at opencv_source_code/samples/cpp/video_dmtx.cpp
 
 VideoCapture::VideoCapture
 ------------------------------
index def8451a2cec06b7f0452cbaf897d24ae36161cc..cadb16492beeb36a3e6eac2c41e0e5dad6fe5312 100644 (file)
@@ -33,6 +33,10 @@ The function ``createTrackbar`` creates a trackbar (a slider or range control) w
 
 Clicking the label of each trackbar enables editing the trackbar values manually.
 
+.. Sample code::
+
+   * : An example of using the trackbar functionality can be found at opencv_source_code/samples/cpp/connected_components.cpp
+
 getTrackbarPos
 ------------------
 Returns the trackbar position.
index df1a193076daa53c0ccbbc88cab75f41046b01eb..1122cefc7641d95cd1aa603b8d392162b596a732 100644 (file)
@@ -32,7 +32,9 @@ Finds edges in an image using the [Canny86]_ algorithm.
 The function finds edges in the input image ``image`` and marks them in the output map ``edges`` using the Canny algorithm. The smallest value between ``threshold1`` and ``threshold2`` is used for edge linking. The largest value is used to find initial segments of strong edges. See
 http://en.wikipedia.org/wiki/Canny_edge_detector
 
+.. Sample code::
 
+   * : An example on using the canny edge detector can be found at opencv_source_code/samples/cpp/edge.cpp
 
 cornerEigenValsAndVecs
 ----------------------
@@ -356,6 +358,9 @@ Example: ::
     :ocv:func:`fitEllipse`,
     :ocv:func:`minEnclosingCircle`
 
+.. Sample code::
+
+   * : An example using the Hough circle detector can be found at opencv_source_code/samples/cpp/houghcircles.cpp
 
 HoughLines
 ----------
@@ -412,6 +417,10 @@ Finds lines in a binary image using the standard Hough transform.
 The function implements the standard or standard multi-scale Hough transform algorithm for line detection.  See http://homepages.inf.ed.ac.uk/rbf/HIPR2/hough.htm for a good explanation of Hough transform.
 See also the example in :ocv:func:`HoughLinesP` description.
 
+.. Sample code::
+
+   * : An example using the Hough line detector can be found at opencv_source_code/samples/cpp/houghlines.cpp
+
 HoughLinesP
 -----------
 Finds line segments in a binary image using the probabilistic Hough transform.
index 0b1f9a34e4913734abb1e9bcc1730b52e0269b8d..4265d9461f17fbaf193f46b47f3b59655fe2aaac 100755 (executable)
@@ -868,6 +868,9 @@ The function supports the in-place mode. Dilation can be applied several ( ``ite
     :ocv:func:`morphologyEx`,
     :ocv:func:`createMorphologyFilter`
 
+.. Sample code::
+
+   * : An example using the morphological dilate operation can be found at opencv_source_code/samples/cpp/morphology2.cpp
 
 erode
 -----
@@ -908,7 +911,9 @@ The function supports the in-place mode. Erosion can be applied several ( ``iter
     :ocv:func:`morphologyEx`,
     :ocv:func:`createMorphologyFilter`
 
+.. Sample code::
 
+   * : An example using the morphological erode operation can be found at opencv_source_code/samples/cpp/morphology2.cpp
 
 filter2D
 --------
@@ -1245,6 +1250,9 @@ Any of the operations can be done in-place. In case of multi-channel images, eac
     :ocv:func:`erode`,
     :ocv:func:`createMorphologyFilter`
 
+.. Sample code::
+
+   * : An example using the morphologyEx function for the morphological opening and closing operations can be found at opencv_source_code/samples/cpp/morphology2.cpp
 
 Laplacian
 ---------
@@ -1290,7 +1298,9 @@ This is done when ``ksize > 1`` . When ``ksize == 1`` , the Laplacian is compute
     :ocv:func:`Sobel`,
     :ocv:func:`Scharr`
 
+.. Sample code::
 
+   * : An example using the Laplace transformation for edge detection can be found at opencv_source_code/samples/cpp/laplace.cpp
 
 pyrDown
 -------
@@ -1400,6 +1410,9 @@ After the iterations over, the color components of the initial pixel (that is, t
 
 When ``maxLevel > 0``, the gaussian pyramid of ``maxLevel+1`` levels is built, and the above procedure is run on the smallest layer first. After that, the results are propagated to the larger layer and the iterations are run again only on those pixels where the layer colors differ by more than ``sr`` from the lower-resolution layer of the pyramid. That makes boundaries of color regions sharper. Note that the results will be actually different from the ones obtained by running the meanshift procedure on the whole original image (i.e. when ``maxLevel==0``).
 
+.. Sample code::
+
+   * : An example using mean-shift image segmentation can be found at opencv_source_code/samples/cpp/meanshift_segmentation.cpp
 
 sepFilter2D
 -----------
index c48da01d7e99c2080f4105eb6b7915d054c6ea82..28f84294e7aabc2e7171d4af6472097beaecf406 100644 (file)
@@ -307,6 +307,9 @@ where
 
 The function emulates the human "foveal" vision and can be used for fast scale and rotation-invariant template matching, for object tracking and so forth. The function can not operate in-place.
 
+.. Sample code::
+
+   * : An example using the geometric logpolar operation in 4 applications can be found at opencv_source_code/samples/cpp/logpolar_bsm.cpp
 
 remap
 -----
index f576d5d755830ce5b39b7940db1d4e30e4bdd152..7ac4d47f8b7a505dc3da511298495058f6c21fce 100644 (file)
@@ -99,7 +99,9 @@ input arrays at the same location. The sample below shows how to compute a 2D Hu
         waitKey();
     }
 
+.. Sample code::
 
+   * : An example for creating histograms of an image can be found at opencv_source_code/samples/cpp/demhist.cpp
 
 
 calcBackProject
index 9fd8df517a78ebde8cd802bafc527e31915ce634..c84a53d2350158de718cf56ff7786dcf8d4ba855 100644 (file)
@@ -481,6 +481,10 @@ In this mode, the complexity is still linear.
 That is, the function provides a very fast way to compute the Voronoi diagram for a binary image.
 Currently, the second variant can use only the approximate distance transform algorithm, i.e. ``maskSize=CV_DIST_MASK_PRECISE`` is not supported yet.
 
+.. Sample code::
+
+   * : An example on using the distance transform can be found at opencv_source_code/samples/cpp/distrans.cpp
+
 floodFill
 ---------
 Fills a connected component with the given color.
@@ -580,11 +584,13 @@ where
 *
     Color/brightness of the seed point in case of a fixed range.
 
-Use these functions to either mark a connected component with the specified color in-place, or build a mask and then extract the contour, or copy the region to another image, and so on. Various modes of the function are demonstrated in the ``floodfill.cpp`` sample.
+Use these functions to either mark a connected component with the specified color in-place, or build a mask and then extract the contour, or copy the region to another image, and so on.
 
 .. seealso:: :ocv:func:`findContours`
 
+.. Sample code::
 
+   * : An example using the FloodFill technique can be found at opencv_source_code/samples/cpp/ffilldemo.cpp
 
 integral
 --------
@@ -748,6 +754,10 @@ Visual demonstration and usage example of the function can be found in the OpenC
 
 .. seealso:: :ocv:func:`findContours`
 
+.. Sample code::
+
+   * : An example using the watershed algorithm can be found at opencv_source_code/samples/cpp/watershed.cpp
+
 grabCut
 -------
 Runs the GrabCut algorithm.
@@ -794,3 +804,7 @@ See the sample ``grabcut.cpp`` to learn how to use the function.
 .. [Meyer92] Meyer, F. *Color Image Segmentation*, ICIP92, 1992
 
 .. [Telea04] Alexandru Telea, *An Image Inpainting Technique Based on the Fast Marching Method*. Journal of Graphics, GPU, and Game Tools 9 1, pp 23-34 (2004)
+
+.. Sample code::
+
+   * : An example using the GrabCut algorithm can be found at opencv_source_code/samples/cpp/grabcut.cpp
\ No newline at end of file
index 37b23510d2f68b7ab05603edf4debef5fafb69f5..3912abe814f2d857e09d0ad38bbe9ad82f85681b 100644 (file)
@@ -166,6 +166,12 @@ The function retrieves contours from the binary image using the algorithm
 
 .. note:: If you use the new Python interface then the ``CV_`` prefix has to be omitted in contour retrieval mode and contour approximation method parameters (for example, use ``cv2.RETR_LIST`` and ``cv2.CHAIN_APPROX_NONE`` parameters). If you use the old Python interface then these parameters have the ``CV_`` prefix (for example, use ``cv.CV_RETR_LIST`` and ``cv.CV_CHAIN_APPROX_NONE``).
 
+.. Sample code::
+
+   * : An example using the findContour functionality can be found at opencv_source_code/samples/cpp/contours2.cpp
+   * : An example using findContours to clean up a background segmentation result at opencv_source_code/samples/cpp/segment_objects.cpp
+
+
 drawContours
 ----------------
 Draws contours outlines or filled contours.
@@ -246,7 +252,10 @@ The function draws contour outlines in the image if
         waitKey(0);
     }
 
+.. Sample code::
 
+   * : An example using the drawContour functionality can be found at opencv_source_code/samples/cpp/contours2.cpp
+   * : An example using drawContours to clean up a background segmentation result at opencv_source_code/samples/cpp/segment_objects.cpp
 
 approxPolyDP
 ----------------
@@ -417,6 +426,10 @@ The functions find the convex hull of a 2D point set using the Sklansky's algori
 that has
 *O(N logN)* complexity in the current implementation. See the OpenCV sample ``convexhull.cpp`` that demonstrates the usage of different function variants.
 
+.. Sample code::
+
+   * : An example using the convexHull functionality can be found at opencv_source_code/samples/cpp/convexhull.cpp
+
 
 convexityDefects
 ----------------
@@ -473,6 +486,10 @@ Fits an ellipse around a set of 2D points.
 
 The function calculates the ellipse that fits (in a least-squares sense) a set of 2D points best of all. It returns the rotated rectangle in which the ellipse is inscribed. The algorithm [Fitzgibbon95]_ is used.
 
+.. Sample code::
+
+   * : An example using the fitEllipse technique can be found at opencv_source_code/samples/cpp/fitellipse.cpp
+
 fitLine
 -----------
 Fits a line to a 2D or 3D point set.
index d97d152e7bfc99098609d737ed4ba6fcf25e7941..aac622acef55fd5e722898ad3259269dc42e6bd5 100644 (file)
@@ -5,6 +5,10 @@ This section describes obsolete ``C`` interface of EM algorithm. Details of the
 
 .. highlight:: cpp
 
+.. Sample code::
+
+   * : An example on using the Expectation Maximalization algorithm can be found at opencv_source_code/samples/cpp/em.cpp
+
 
 CvEMParams
 ----------
index 222d7a03a66646a7c3d7b0599b6ca415ed693f4c..4dfabfb1ee4558566be7339372db5933dab613d6 100644 (file)
@@ -99,7 +99,9 @@ Trains a randomized tree using an input set of keypoints.
 
     :param num_quant_bits: Number of bits used for quantization.
 
+.. Sample code::
 
+   * : An example on training a Random Tree Classifier for letter recognition can be found at opencv_source_code\samples\cpp\letter_recog.cpp
 
 RandomizedTree::read
 ------------------------
index c7ccb749324b3a0d509570a151d24d733afcdc0e..526aba513ba4b1897d481d8d4d77d61494459c96 100644 (file)
@@ -75,6 +75,10 @@ SURF
 
 .. [Bay06] Bay, H. and Tuytelaars, T. and Van Gool, L. "SURF: Speeded Up Robust Features", 9th European Conference on Computer Vision, 2006
 
+.. Sample code::
+
+   * : An example using the SURF feature detector can be found at opencv_source_code/samples/cpp/generic_descriptor_match.cpp
+   * : Another example using the SURF feature detector, extractor and matcher can be found at opencv_source_code/samples/cpp/matcher_simple.cpp
 
 SURF::SURF
 ----------
index ef69ebc708a4160fb187223b12b7495e769749f4..2f7a8994413d5334ec6f1eb3428a9ba220d9e615 100644 (file)
@@ -31,3 +31,7 @@ Restores the selected region in an image using the region neighborhood.
 The function reconstructs the selected image area from the pixel near the area boundary. The function may be used to remove dust and scratches from a scanned photo, or to remove undesirable objects from still images or video. See
 http://en.wikipedia.org/wiki/Inpainting
 for more details.
+
+.. Sample code::
+
+   * : An example using the inpainting technique can be found at opencv_source_code/samples/cpp/inpaint.cpp
\ No newline at end of file
index 5834072089d8e869279d68037f079c311eb3dfbd..bc0819519411c27326b839d771c55dc6d751570f 100644 (file)
@@ -88,6 +88,11 @@ High level image stitcher. It's possible to use this class without being aware o
         /* hidden */
     };
 
+.. Sample code::
+
+   * : A basic example on image stitching can be found at opencv_source_code/samples/cpp/stitching.cpp
+   * : A detailed example on image stitching can be found at opencv_source_code/samples/cpp/stitching_detailed.cpp
+
 Stitcher::createDefault
 -----------------------
 Creates a stitcher with the default parameters.
index 5653e21bdf41546b5ff99dad568e397d7494a072..4b3232175beddaa58ab941db4a944dc86de1988a 100644 (file)
@@ -42,6 +42,10 @@ Calculates an optical flow for a sparse feature set using the iterative Lucas-Ka
 
 The function implements a sparse iterative version of the Lucas-Kanade optical flow in pyramids. See [Bouguet00]_. The function is parallelized with the TBB library.
 
+.. Sample code::
+
+   * : An example using the Lucas-Kanade optical flow algorithm can be found at opencv_source_code/samples/cpp/lkdemo.cpp
+
 buildOpticalFlowPyramid
 -----------------------
 Constructs the image pyramid which can be passed to :ocv:func:`calcOpticalFlowPyrLK`.
@@ -109,6 +113,9 @@ The function finds an optical flow for each ``prev`` pixel using the [Farneback2
 
     \texttt{prev} (y,x)  \sim \texttt{next} ( y + \texttt{flow} (y,x)[1],  x + \texttt{flow} (y,x)[0])
 
+.. Sample code::
+
+   * : An example using the optical flow algorithm described by Gunnar Farneback can be found at opencv_source_code/samples/cpp/fback.cpp
 
 estimateRigidTransform
 --------------------------
@@ -342,7 +349,9 @@ The function implements the iterative object search algorithm. It takes the inpu
 :ocv:func:`contourArea` ), and rendering the  remaining contours with
 :ocv:func:`drawContours` .
 
+.. Sample code::
 
+   * : A mean-shift tracking sample can be found at opencv_source_code/samples/cpp/camshiftdemo.cpp
 
 KalmanFilter
 ------------
@@ -353,7 +362,9 @@ KalmanFilter
 The class implements a standard Kalman filter
 http://en.wikipedia.org/wiki/Kalman_filter, [Welch95]_. However, you can modify ``transitionMatrix``, ``controlMatrix``, and ``measurementMatrix`` to get an extended Kalman filter functionality. See the OpenCV sample ``kalman.cpp`` .
 
+.. Sample code::
 
+   * : An example using the standard Kalman filter can be found at opencv_source_code/samples/cpp/kalman.cpp
 
 
 KalmanFilter::KalmanFilter
@@ -641,7 +652,9 @@ Calculate an optical flow using "SimpleFlow" algorithm.
 
 See [Tao2012]_. And site of project - http://graphics.berkeley.edu/papers/Tao-SAN-2012-05/.
 
+.. Sample code::
 
+   * : An example using the simpleFlow algorithm can be found at opencv_source_code/samples/cpp/simpleflow_demo.cpp
 
 createOptFlow_DualTVL1
 ----------------------