generic-library/opencv
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Documentation: fixed about 100 cross-referencing errors.

Browse Source
This commit is contained in:
Andrey Kamaev
2011-08-13 16:49:40 +00:00
parent 6395a738cb
commit d6e3ccc1b2
34 changed files with 128 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
modules/core/doc/basic_structures.rst
View File

@@ -246,7 +246,7 @@ Template class for short numerical vectors, a partial case of :ocv:class:`Matx`:
typedef Vec<double, 4> Vec4d;
typedef Vec<double, 6> Vec6d;
It is possible to convert ``Vec<T,2>`` to/from ``Point_``, ``Vec<T,3>`` to/from ``Point3_`` , and ``Vec<T,4>`` to ``CvScalar`` or :ocv:class:`Scalar`. Use ``operator[]`` to access the elements of ``Vec``.
It is possible to convert ``Vec<T,2>`` to/from ``Point_``, ``Vec<T,3>`` to/from ``Point3_`` , and ``Vec<T,4>`` to :ocv:struct:`CvScalar` or :ocv:class:`Scalar_`. Use ``operator[]`` to access the elements of ``Vec``.
All the expected vector operations are also implemented:
@@ -1517,11 +1517,11 @@ The method is used in quite a few of OpenCV functions. The point is that element
This approach, while being very simple, can boost the performance of a simple element-operation by 10-20 percents, especially if the image is rather small and the operation is quite simple.
Another OpenCV idiom in this function, a call of
:ocv:func:`Mat::create` for the destination array, that allocates the destination array unless it already has the proper size and type. And while the newly allocated arrays are always continuous, you still need to check the destination array because :ocv:func:`create` does not always allocate a new matrix.
:ocv:func:`Mat::create` for the destination array, that allocates the destination array unless it already has the proper size and type. And while the newly allocated arrays are always continuous, you still need to check the destination array because :ocv:func:`Mat::create` does not always allocate a new matrix.
Mat::elemSize
-----------------
-------------
Returns the matrix element size in bytes.
.. ocv:function:: size_t Mat::elemSize() const
@@ -1530,7 +1530,7 @@ The method returns the matrix element size in bytes. For example, if the matrix
Mat::elemSize1
------------------
--------------
Returns the size of each matrix element channel in bytes.
.. ocv:function:: size_t Mat::elemSize1() const
@@ -1539,7 +1539,7 @@ The method returns the matrix element channel size in bytes, that is, it ignores
Mat::type
-------------
---------
Returns the type of a matrix element.
.. ocv:function:: int Mat::type() const
@@ -1622,7 +1622,7 @@ Returns a pointer to the specified matrix row.
:param i: A 0-based row index.
The methods return ``uchar*`` or typed pointer to the specified matrix row. See the sample in
:ocv:func:`Mat::isContinuous` () to know how to use these methods.
:ocv:func:`Mat::isContinuous` to know how to use these methods.
Mat::at

2
modules/core/doc/drawing_functions.rst
View File

@@ -6,7 +6,7 @@ Drawing Functions
Drawing functions work with matrices/images of arbitrary depth.
The boundaries of the shapes can be rendered with antialiasing (implemented only for 8-bit images for now).
All the functions include the parameter ``color`` that uses an RGB value (that may be constructed
with ``CV_RGB`` or the :ocv:class:`Scalar` constructor
with ``CV_RGB`` or the :ocv:class:`Scalar_` constructor
) for color
images and brightness for grayscale images. For color images, the channel ordering
is normally *Blue, Green, Red*.

2
modules/core/doc/dynamic_structures.rst
View File

@@ -43,7 +43,7 @@ The buffer is put in the end of already allocated space in the ``top`` memory bl
If there are no more free blocks, a new block is allocated (or borrowed from the parent, see :ocv:cfunc:`CreateChildMemStorage`) and added to the end of list. Thus, the storage behaves as a stack with ``bottom`` indicating bottom of the stack and the pair (``top``, ``free_space``)
indicating top of the stack. The stack top may be saved via :ocv:cfunc:`SaveMemStoragePos`, restored via
:ocv:cfunc:`RestoreMemStoragePos`, or reset via :ocv:cfunc:`ClearStorage`.
:ocv:cfunc:`RestoreMemStoragePos`, or reset via :ocv:cfunc:`ClearMemStorage`.
CvMemBlock
----------

14
modules/core/doc/old_basic_structures.rst
View File

@@ -671,7 +671,7 @@ Creates a matrix header but does not allocate the matrix data.
:param type: Type of the matrix elements, see :ocv:cfunc:`CreateMat`
The function allocates a new matrix header and returns a pointer to it. The matrix data can then be allocated using :ocv:cfunc:`CreateData` or set explicitly to user-allocated data via :ocv:func:`SetData`.
The function allocates a new matrix header and returns a pointer to it. The matrix data can then be allocated using :ocv:cfunc:`CreateData` or set explicitly to user-allocated data via :ocv:cfunc:`SetData`.
CreateMatND
-----------
@@ -719,7 +719,7 @@ Creates sparse array.
:param type: Type of array elements. The same as for CvMat
The function allocates a multi-dimensional sparse array. Initially the array contain no elements, that is
:ocv:cfunc:`GetPtrND` and other related functions will return 0 for every index.
:ocv:cfunc:`PtrND` and other related functions will return 0 for every index.
CrossProduct
@@ -935,7 +935,7 @@ The function returns a matrix header for the input array that can be a matrix -
The function provides an easy way to handle both types of arrays - ``IplImage`` and ``CvMat`` using the same code. Input array must have non-zero data pointer, otherwise the function will report an error.
.. seealso:: :ocv:cfunc:`GetImage`, :ocv:cfunc:`GetMatND`, :ocv:func:`cvarrToMat`.
.. seealso:: :ocv:cfunc:`GetImage`, :ocv:func:`cvarrToMat`.
.. note:: If the input array is ``IplImage`` with planar data layout and COI set, the function returns the pointer to the selected plane and ``COI == 0``. This feature allows user to process ``IplImage`` strctures with planar data layout, even though OpenCV does not support such images.
@@ -1250,13 +1250,15 @@ The functions return a pointer to a specific array element. Number of array dime
The functions can be used for sparse arrays as well - if the requested node does not exist they create it and set it to zero.
All these as well as other functions accessing array elements (
:ocv:cfunc:`Get`
:ocv:cfunc:`GetND`
,
:ocv:cfunc:`GetReal`
:ocv:cfunc:`GetRealND`
,
:ocv:cfunc:`Set`
,
:ocv:cfunc:`SetReal`
:ocv:cfunc:`SetND`
,
:ocv:cfunc:`SetRealND`
) raise an error in case if the element index is out of range.

2
modules/core/doc/old_xml_yaml_persistence.rst
View File

@@ -681,7 +681,7 @@ Starts writing a new structure.
following the structure name (see the example in :ocv:struct:`CvFileStorage`
description). Mainly it is used with user objects. When the storage
is read, the encoded type name is used to determine the object type
(see :ocv:struct:`CvTypeInfo` and :ocv:cfunc:`FindTypeInfo` ).
(see :ocv:struct:`CvTypeInfo` and :ocv:cfunc:`FindType` ).
:param attributes: This parameter is not used in the current implementation

25
modules/core/doc/operations_on_arrays.rst
View File

@@ -695,18 +695,17 @@ Normally, the function is used to convert an old-style 2D array (
``CvMatND`` using an arbitrary element-wise function.
The last parameter, ``coiMode`` , specifies how to deal with an image with COI set. By default, it is 0 and the function reports an error when an image with COI comes in. And ``coiMode=1`` means that no error is signalled. You have to check COI presence and handle it manually. The modern structures, such as
:ocv:func:`Mat` and
:ocv:func:`MatND` do not support COI natively. To process an individual channel of a new-style array, you need either to organize a loop over the array (for example, using matrix iterators) where the channel of interest will be processed, or extract the COI using
:ocv:class:`Mat` and
``MatND`` do not support COI natively. To process an individual channel of a new-style array, you need either to organize a loop over the array (for example, using matrix iterators) where the channel of interest will be processed, or extract the COI using
:ocv:func:`mixChannels` (for new-style arrays) or
:ocv:func:`extractImageCOI` (for old-style arrays), process this individual channel, and insert it back to the destination array if needed (using
:ocv:func:`mixChannel` or
:ocv:func:`mixChannels` or
:ocv:func:`insertImageCOI` , respectively).
.. seealso::
:c:func:`cvGetImage`,
:c:func:`cvGetMat`,
:c:func:`cvGetMatND`,
:ocv:cfunc:`cvGetImage`,
:ocv:cfunc:`cvGetMat`,
:ocv:func:`extractImageCOI`,
:ocv:func:`insertImageCOI`,
:ocv:func:`mixChannels`
@@ -1606,7 +1605,7 @@ Calculates an average (mean) of array elements.
.. ocv:cfunction:: CvScalar cvAvg(const CvArr* src, const CvArr* mask=NULL)
.. ocv:pyoldfunction:: cv.Avg(src, mask=None)-> CvScalar
:param src: Source array that should have from 1 to 4 channels so that the result can be stored in :ocv:func:`Scalar` .
:param src: Source array that should have from 1 to 4 channels so that the result can be stored in :ocv:class:`Scalar_` .
:param mask: Optional operation mask.
@@ -1638,7 +1637,7 @@ Calculates a mean and standard deviation of array elements.
.. ocv:cfunction:: void cvAvgSdv(const CvArr* src, CvScalar* mean, CvScalar* stdDev, const CvArr* mask=NULL)
.. ocv:pyoldfunction:: cv.AvgSdv(src, mask=None)-> (mean, stdDev)
:param src: Source array that should have from 1 to 4 channels so that the results can be stored in :ocv:func:`Scalar` 's.
:param src: Source array that should have from 1 to 4 channels so that the results can be stored in :ocv:class:`Scalar_` 's.
:param mean: Output parameter: computed mean value.
@@ -1786,11 +1785,11 @@ Finds the global minimum and maximum in a whole array or sub-array.
:param mask: Optional mask used to select a sub-array.
The functions ``ninMaxLoc`` find the minimum and maximum element values and their positions. The extremums are searched across the whole array or,
The functions ``minMaxLoc`` find the minimum and maximum element values and their positions. The extremums are searched across the whole array or,
if ``mask`` is not an empty array, in the specified array region.
The functions do not work with multi-channel arrays. If you need to find minimum or maximum elements across all the channels, use
:ocv:func:`reshape` first to reinterpret the array as single-channel. Or you may extract the particular channel using either
:ocv:func:`Mat::reshape` first to reinterpret the array as single-channel. Or you may extract the particular channel using either
:ocv:func:`extractImageCOI` , or
:ocv:func:`mixChannels` , or
:ocv:func:`split` .
@@ -1806,7 +1805,7 @@ In case of a sparse matrix, the minimum is found among non-zero elements only.
:ocv:func:`extractImageCOI`,
:ocv:func:`mixChannels`,
:ocv:func:`split`,
:ocv:func:`reshape`
:ocv:func:`Mat::reshape`
@@ -1931,7 +1930,7 @@ For a not-per-element matrix product, see
.. seealso::
:ocv:func:`add`,
:ocv:func:`substract`,
:ocv:func:`subtract`,
:ocv:func:`divide`,
:ref:`MatrixExpressions`,
:ocv:func:`scaleAdd`,
@@ -2530,7 +2529,7 @@ Fills arrays with random numbers.
.. ocv:function:: void RNG::fill( InputOutputArray mat, int distType, InputArray a, InputArray b )
:param mat: 2D or N-dimensional matrix. Currently matrices with more than 4 channels are not supported by the methods. Use :ocv:func:`reshape` as a possible workaround.
:param mat: 2D or N-dimensional matrix. Currently matrices with more than 4 channels are not supported by the methods. Use :ocv:func:`Mat::reshape` as a possible workaround.
:param distType: Distribution type, ``RNG::UNIFORM`` or ``RNG::NORMAL`` .

2
modules/core/doc/xml_yaml_persistence.rst
View File

@@ -10,7 +10,7 @@ You can store and then restore various OpenCV data structures to/from XML (http:
(http://www.yaml.org) formats. Also, it is possible store and load arbitrarily complex data structures, which include OpenCV data structures, as well as primitive data types (integer and floating-point numbers and text strings) as their elements.
Use the following procedure to write something to XML or YAML:
#. Create new :ocv:class:`FileStorage` and open it for writing. It can be done with a single call to :ocv:func:`FileStorage::FileStorage` constructor that takes a filename, or you can use the default constructor and then call :ocv:class:`FileStorage::open`. Format of the file (XML or YAML) is determined from the filename extension (".xml" and ".yml"/".yaml", respectively)
#. Create new :ocv:class:`FileStorage` and open it for writing. It can be done with a single call to :ocv:func:`FileStorage::FileStorage` constructor that takes a filename, or you can use the default constructor and then call :ocv:func:`FileStorage::open`. Format of the file (XML or YAML) is determined from the filename extension (".xml" and ".yml"/".yaml", respectively)
#. Write all the data you want using the streaming operator ``>>``, just like in the case of STL streams.
#. Close the file using :ocv:func:`FileStorage::release`. ``FileStorage`` destructor also closes the file.