org.bytedeco.javacpp

Class opencv_imgproc.LineIterator

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.opencv_imgproc.LineIterator

All Implemented Interfaces:

AutoCloseable

Enclosing class:

opencv_imgproc

@Namespace(value="cv")
 @NoOffset
public static class opencv_imgproc.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

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

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

Method Summary

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

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, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, 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
                    opencv_core.Mat img,
                    @ByVal
                    opencv_core.Point pt1,
                    @ByVal
                    opencv_core.Point pt2,
                    int connectivity,
                    @Cast(value="bool")
                    boolean leftToRight)

\brief intializes 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
                    opencv_core.Mat img,
                    @ByVal
                    opencv_core.Point pt1,
                    @ByVal
                    opencv_core.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 opencv_imgproc.LineIterator increment()

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

increment

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

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

pos

@ByVal
public opencv_core.Point pos()

\brief returns coordinates of the current pixel

ptr

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

ptr

public opencv_imgproc.LineIterator ptr(BytePointer ptr)

ptr0

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

step

public int step()

step

public opencv_imgproc.LineIterator step(int step)

elemSize

public int elemSize()

elemSize

public opencv_imgproc.LineIterator elemSize(int elemSize)

err

public int err()

err

public opencv_imgproc.LineIterator err(int err)

count

public int count()

count

public opencv_imgproc.LineIterator count(int count)

minusDelta

public int minusDelta()

minusDelta

public opencv_imgproc.LineIterator minusDelta(int minusDelta)

plusDelta

public int plusDelta()

plusDelta

public opencv_imgproc.LineIterator plusDelta(int plusDelta)

minusStep

public int minusStep()

minusStep

public opencv_imgproc.LineIterator minusStep(int minusStep)

plusStep

public int plusStep()

plusStep

public opencv_imgproc.LineIterator plusStep(int plusStep)