org.bytedeco.opencv.opencv_imgproc

Class LineIterator

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_imgproc.LineIterator

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv")
 @NoOffset
 @Properties(inherit=opencv_imgproc.class)
public class LineIterator
extends Pointer

\brief Line iterator

The class is used to iterate over all the pixels on the raster line segment connecting two specified points.

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 method LineIterator::pos returns the current position in the image:

 {.cpp}
// 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);
}

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
LineIterator(Mat img, Point pt1, Point pt2)
LineIterator(Mat img, Point pt1, Point pt2, int connectivity, boolean leftToRight) \brief initializes the iterator
LineIterator(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	count()
LineIterator	count(int setter)
int	elemSize()
LineIterator	elemSize(int setter)
int	err()
LineIterator	err(int setter)
LineIterator	increment() \brief prefix increment operator (++it).
LineIterator	increment(int arg0) \brief postfix increment operator (it++).
int	minusDelta()
LineIterator	minusDelta(int setter)
int	minusStep()
LineIterator	minusStep(int setter)
BytePointer	multiply() \brief returns pointer to the current pixel
int	plusDelta()
LineIterator	plusDelta(int setter)
int	plusStep()
LineIterator	plusStep(int setter)
Point	pos() \brief returns coordinates of the current pixel
BytePointer	ptr()
LineIterator	ptr(BytePointer setter)
BytePointer	ptr0()
LineIterator	ptr0(BytePointer setter)
int	step()
LineIterator	step(int setter)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LineIterator

public LineIterator(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

LineIterator

public LineIterator(@Const @ByRef
                    Mat img,
                    @ByVal
                    Point pt1,
                    @ByVal
                    Point pt2,
                    int connectivity,
                    @Cast(value="bool")
                    boolean leftToRight)

\brief initializes the iterator

creates iterators for the line connecting pt1 and pt2 the line will be clipped on the image boundaries the line is 8-connected or 4-connected If leftToRight=true, then the iteration is always done from the left-most point to the right most, not to depend on the ordering of pt1 and pt2 parameters

LineIterator

public LineIterator(@Const @ByRef
                    Mat img,
                    @ByVal
                    Point pt1,
                    @ByVal
                    Point pt2)

Method Detail

multiply

@Cast(value="uchar*")
 @Name(value="operator *")
public BytePointer multiply()

\brief returns pointer to the current pixel

increment

@ByRef
 @Name(value="operator ++")
public LineIterator increment()

\brief prefix increment operator (++it). shifts iterator to the next pixel

increment

@ByVal
 @Name(value="operator ++")
public LineIterator increment(int arg0)

\brief postfix increment operator (it++). shifts iterator to the next pixel

pos

@ByVal
public Point pos()

\brief returns coordinates of the current pixel

ptr

@Cast(value="uchar*")
public BytePointer ptr()

ptr

public LineIterator ptr(BytePointer setter)

ptr0

@Cast(value="const uchar*")
public BytePointer ptr0()

ptr0

public LineIterator ptr0(BytePointer setter)

step

public int step()

step

public LineIterator step(int setter)

elemSize

public int elemSize()

elemSize

public LineIterator elemSize(int setter)

err

public int err()

err

public LineIterator err(int setter)

count

public int count()

count

public LineIterator count(int setter)

minusDelta

public int minusDelta()

minusDelta

public LineIterator minusDelta(int setter)

plusDelta

public int plusDelta()

plusDelta

public LineIterator plusDelta(int setter)

minusStep

public int minusStep()

minusStep

public LineIterator minusStep(int setter)

plusStep

public int plusStep()

plusStep

public LineIterator plusStep(int setter)