org.bytedeco.javacpp

Class opencv_core.NAryMatIterator

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.opencv_core.NAryMatIterator

Enclosing class:

opencv_core

public static class opencv_core.NAryMatIterator
extends Pointer

n-Dimensional Dense Matrix Iterator Class. The class cv::NAryMatIterator is used for iterating over one or more n-dimensional dense arrays (cv::Mat's). The iterator is completely different from cv::Mat_ and cv::SparseMat_ iterators. It iterates through the slices (or planes), not the elements, where "slice" is a continuous part of the arrays. Here is the example on how the iterator can be used to normalize 3D histogram: \code void normalizeColorHist(Mat& hist) { #if 1 // intialize iterator (the style is different from STL). // after initialization the iterator will contain // the number of slices or planes // the iterator will go through Mat* arrays[] = { &hist, 0 }; Mat planes[1]; NAryMatIterator it(arrays, planes); double s = 0; // iterate through the matrix. on each iteration // it.planes[i] (of type Mat) will be set to the current plane of // i-th n-dim matrix passed to the iterator constructor. for(int p = 0; p < it.nplanes; p++, ++it) s += sum(it.planes[0])[0]; it = NAryMatIterator(hist); s = 1./s; for(int p = 0; p < it.nplanes; p++, ++it) it.planes[0] *= s; #elif 1 // this is a shorter implementation of the above // using built-in operations on Mat double s = sum(hist)[0]; hist.convertTo(hist, hist.type(), 1./s, 0); #else // and this is even shorter one // (assuming that the histogram elements are non-negative) normalize(hist, hist, 1, 0, NORM_L1); #endif } \endcode You can iterate through several matrices simultaneously as long as they have the same geometry (dimensionality and all the dimension sizes are the same), which is useful for binary and n-ary operations on such matrices. Just pass those matrices to cv::MatNDIterator. Then, during the iteration it.planes[0], it.planes[1], ... will be the slices of the corresponding matrices

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
opencv_core.NAryMatIterator() the default constructor
opencv_core.NAryMatIterator(int size)
opencv_core.NAryMatIterator(opencv_core.Mat arrays, byte[] ptrs)
opencv_core.NAryMatIterator(opencv_core.Mat arrays, byte[] ptrs, int narrays)
opencv_core.NAryMatIterator(opencv_core.Mat arrays, ByteBuffer ptrs)
opencv_core.NAryMatIterator(opencv_core.Mat arrays, ByteBuffer ptrs, int narrays)
opencv_core.NAryMatIterator(opencv_core.Mat arrays, BytePointer ptrs)
opencv_core.NAryMatIterator(opencv_core.Mat arrays, BytePointer ptrs, int narrays)
opencv_core.NAryMatIterator(opencv_core.Mat arrays, opencv_core.Mat planes)
opencv_core.NAryMatIterator(opencv_core.Mat arrays, opencv_core.Mat planes, int narrays)
opencv_core.NAryMatIterator(Pointer p)
opencv_core.NAryMatIterator(PointerPointer arrays, opencv_core.Mat planes, int narrays) the full constructor taking arbitrary number of n-dim matrices
opencv_core.NAryMatIterator(PointerPointer arrays, PointerPointer ptrs, int narrays) the full constructor taking arbitrary number of n-dim matrices

Method Summary

Methods

Modifier and Type	Method and Description
PointerPointer	arrays()
opencv_core.Mat	arrays(int i) the iterated arrays
opencv_core.NAryMatIterator	increment() proceeds to the next plane of every iterated matrix
opencv_core.NAryMatIterator	increment(int arg0) proceeds to the next plane of every iterated matrix (postfix increment operator)
void	init(opencv_core.Mat arrays, opencv_core.Mat planes, byte[] ptrs)
void	init(opencv_core.Mat arrays, opencv_core.Mat planes, byte[] ptrs, int narrays)
void	init(opencv_core.Mat arrays, opencv_core.Mat planes, ByteBuffer ptrs)
void	init(opencv_core.Mat arrays, opencv_core.Mat planes, ByteBuffer ptrs, int narrays)
void	init(opencv_core.Mat arrays, opencv_core.Mat planes, BytePointer ptrs)
void	init(opencv_core.Mat arrays, opencv_core.Mat planes, BytePointer ptrs, int narrays)
void	init(PointerPointer arrays, opencv_core.Mat planes, PointerPointer ptrs, int narrays) the separate iterator initialization method
int	narrays() the number of arrays
opencv_core.NAryMatIterator	narrays(int narrays)
long	nplanes() the number of hyper-planes that the iterator steps through
opencv_core.NAryMatIterator	nplanes(long nplanes)
opencv_core.Mat	planes() the current planes
opencv_core.NAryMatIterator	planes(opencv_core.Mat planes)
opencv_core.NAryMatIterator	position(int position)
PointerPointer	ptrs()
BytePointer	ptrs(int i) data pointers
opencv_core.NAryMatIterator	ptrs(int i, BytePointer ptrs)
long	size() the size of each segment (in elements)
opencv_core.NAryMatIterator	size(long size)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, capacity, capacity, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, hashCode, isNull, limit, limit, memchr, memcmp, memcpy, memmove, memset, offsetof, position, put, setNull, sizeof, toString, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(Pointer p)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(int size)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator()

the default constructor

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(PointerPointer arrays,
                           PointerPointer ptrs,
                           int narrays)

the full constructor taking arbitrary number of n-dim matrices

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(opencv_core.Mat arrays,
                           BytePointer ptrs)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(opencv_core.Mat arrays,
                           BytePointer ptrs,
                           int narrays)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(opencv_core.Mat arrays,
                           ByteBuffer ptrs,
                           int narrays)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(opencv_core.Mat arrays,
                           ByteBuffer ptrs)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(opencv_core.Mat arrays,
                           byte[] ptrs,
                           int narrays)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(opencv_core.Mat arrays,
                           byte[] ptrs)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(PointerPointer arrays,
                           opencv_core.Mat planes,
                           int narrays)

the full constructor taking arbitrary number of n-dim matrices

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(opencv_core.Mat arrays,
                           opencv_core.Mat planes)

opencv_core.NAryMatIterator

public opencv_core.NAryMatIterator(opencv_core.Mat arrays,
                           opencv_core.Mat planes,
                           int narrays)

Method Detail

position

public opencv_core.NAryMatIterator position(int position)

Overrides:

position in class Pointer

init

public void init(PointerPointer arrays,
        opencv_core.Mat planes,
        PointerPointer ptrs,
        int narrays)

the separate iterator initialization method

init

public void init(opencv_core.Mat arrays,
        opencv_core.Mat planes,
        BytePointer ptrs)

init

public void init(opencv_core.Mat arrays,
        opencv_core.Mat planes,
        BytePointer ptrs,
        int narrays)

init

public void init(opencv_core.Mat arrays,
        opencv_core.Mat planes,
        ByteBuffer ptrs,
        int narrays)

init

public void init(opencv_core.Mat arrays,
        opencv_core.Mat planes,
        ByteBuffer ptrs)

init

public void init(opencv_core.Mat arrays,
        opencv_core.Mat planes,
        byte[] ptrs,
        int narrays)

init

public void init(opencv_core.Mat arrays,
        opencv_core.Mat planes,
        byte[] ptrs)

increment

public opencv_core.NAryMatIterator increment()

proceeds to the next plane of every iterated matrix

increment

public opencv_core.NAryMatIterator increment(int arg0)

proceeds to the next plane of every iterated matrix (postfix increment operator)

arrays

public opencv_core.Mat arrays(int i)

the iterated arrays

arrays

public PointerPointer arrays()

planes

public opencv_core.Mat planes()

the current planes

planes

public opencv_core.NAryMatIterator planes(opencv_core.Mat planes)

ptrs

public BytePointer ptrs(int i)

data pointers

ptrs

public opencv_core.NAryMatIterator ptrs(int i,
                               BytePointer ptrs)

ptrs

public PointerPointer ptrs()

narrays

public int narrays()

the number of arrays

narrays

public opencv_core.NAryMatIterator narrays(int narrays)

nplanes

public long nplanes()

the number of hyper-planes that the iterator steps through

nplanes

public opencv_core.NAryMatIterator nplanes(long nplanes)

size

public long size()

the size of each segment (in elements)

size

public opencv_core.NAryMatIterator size(long size)