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

updated description of LineIterator with information about LineIterator::pos() (ticket #2338)

Browse Source
This commit is contained in:
Vadim Pisarevsky 2012-09-11 20:20:05 +04:00
parent 52ede9c84d
commit e94cd1ec72
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -384,6 +384,7 @@ Class for iterating pixels on a raster line. ::
// move the iterator to the next pixel
LineIterator& operator ++();
LineIterator operator ++(int);
Point pos() const;
// internal state of the iterator
uchar* ptr;
@ -394,16 +395,23 @@ Class for iterating pixels on a raster line. ::
The class ``LineIterator`` is used to get each pixel of a raster line. It can be treated as versatile implementation of the Bresenham algorithm where you can stop at each pixel and do some extra processing, for example, grab pixel values along the line or draw a line with an effect (for example, with XOR operation).
The number of pixels along the line is stored in ``LineIterator::count`` . ::
The number of pixels along the line is stored in ``LineIterator::count`` . The method ``LineIterator::pos`` returns the current position in the image ::
// grabs pixels along the line (pt1, pt2)
// from 8-bit 3-channel image to the buffer
LineIterator it(img, pt1, pt2, 8);
LineIterator it2 = it;
vector<Vec3b> buf(it.count);
for(int i = 0; i < it.count; i++, ++it)
buf[i] = *(const Vec3b)*it;
// alternative way of iterating through the line
for(int i = 0; i < it2.count; i++, ++it2)
{
Vec3b val = img.at<Vec3b>(it2.pos());
CV_Assert(buf[i] == val);
}
rectangle