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

minor changes in documentation

Browse Source
This commit is contained in:
Alexander Shishkov
2012-04-13 07:31:10 +00:00
parent b6dac61e96
commit d77fb60017
4 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -126,16 +126,22 @@ There are helper functions to construct the slice and to compute its length:
.. ocv:cfunction:: CvSlice cvSlice( int start, int end )
:param start: Inclusive left boundary.
:param end: Exclusive right boundary.
::
#define CV_WHOLE_SEQ_END_INDEX 0x3fffffff
#define CV_WHOLE_SEQ cvSlice(0, CV_WHOLE_SEQ_END_INDEX)
..
.. ocv:cfunction:: int cvSliceLength( CvSlice slice, const CvSeq* seq )
Calculates the sequence slice length
:param slice: The slice of sequence.
:param seq: Source sequence.
Calculates the sequence slice length.
Some of functions that operate on sequences take a ``CvSlice slice`` parameter that is often set to the whole sequence (CV_WHOLE_SEQ) by default. Either of the ``start_index`` and ``end_index`` may be negative or exceed the sequence length. If they are equal, the slice is considered empty (i.e., contains no elements). Because sequences are treated as circular structures, the slice may select a
few elements in the end of a sequence followed by a few elements at the beginning of the sequence. For example, ``cvSlice(-2, 3)`` in the case of a 10-element sequence will select a 5-element slice, containing the pre-last (8th), last (9th), the very first (0th), second (1th) and third (2nd)