org.bytedeco.javacpp

Class opencv_imgproc.FilterEngine

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.opencv_imgproc.FilterEngine

Enclosing class:

opencv_imgproc

public static class opencv_imgproc.FilterEngine
extends Pointer

The Main Class for Image Filtering. The class can be used to apply an arbitrary filtering operation to an image. It contains all the necessary intermediate buffers, it computes extrapolated values of the "virtual" pixels outside of the image etc. Pointers to the initialized cv::FilterEngine instances are returned by various OpenCV functions, such as cv::createSeparableLinearFilter(), cv::createLinearFilter(), cv::createGaussianFilter(), cv::createDerivFilter(), cv::createBoxFilter() and cv::createMorphologyFilter(). Using the class you can process large images by parts and build complex pipelines that include filtering as some of the stages. If all you need is to apply some pre-defined filtering operation, you may use cv::filter2D(), cv::erode(), cv::dilate() etc. functions that create FilterEngine internally. Here is the example on how to use the class to implement Laplacian operator, which is the sum of second-order derivatives. More complex variant for different types is implemented in cv::Laplacian(). \code void laplace_f(const Mat& src, Mat& dst) { CV_Assert( src.type() == CV_32F ); // make sure the destination array has the proper size and type dst.create(src.size(), src.type()); // get the derivative and smooth kernels for d2I/dx2. // for d2I/dy2 we could use the same kernels, just swapped Mat kd, ks; getSobelKernels( kd, ks, 2, 0, ksize, false, ktype ); // let's process 10 source rows at once int DELTA = std::min(10, src.rows); Ptr Fxx = createSeparableLinearFilter(src.type(), dst.type(), kd, ks, Point(-1,-1), 0, borderType, borderType, Scalar() ); Ptr Fyy = createSeparableLinearFilter(src.type(), dst.type(), ks, kd, Point(-1,-1), 0, borderType, borderType, Scalar() ); int y = Fxx->start(src), dsty = 0, dy = 0; Fyy->start(src); const uchar* sptr = src.data + y*src.step; // allocate the buffers for the spatial image derivatives; // the buffers need to have more than DELTA rows, because at the // last iteration the output may take max(kd.rows-1,ks.rows-1) // rows more than the input. Mat Ixx( DELTA + kd.rows - 1, src.cols, dst.type() ); Mat Iyy( DELTA + kd.rows - 1, src.cols, dst.type() ); // inside the loop we always pass DELTA rows to the filter // (note that the "proceed" method takes care of possibe overflow, since // it was given the actual image height in the "start" method) // on output we can get: // * < DELTA rows (the initial buffer accumulation stage) // * = DELTA rows (settled state in the middle) // * > DELTA rows (then the input image is over, but we generate // "virtual" rows using the border mode and filter them) // this variable number of output rows is dy. // dsty is the current output row. // sptr is the pointer to the first input row in the portion to process for( ; dsty < dst.rows; sptr += DELTA*src.step, dsty += dy ) { Fxx->proceed( sptr, (int)src.step, DELTA, Ixx.data, (int)Ixx.step ); dy = Fyy->proceed( sptr, (int)src.step, DELTA, d2y.data, (int)Iyy.step ); if( dy > 0 ) { Mat dstripe = dst.rowRange(dsty, dsty + dy); add(Ixx.rowRange(0, dy), Iyy.rowRange(0, dy), dstripe); } } } \endcode

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
FilterEngine() the default constructor
FilterEngine(int size)
FilterEngine(opencv_imgproc.BaseFilter _filter2D, opencv_imgproc.BaseRowFilter _rowFilter, opencv_imgproc.BaseColumnFilter _columnFilter, int srcType, int dstType, int bufType)
FilterEngine(opencv_imgproc.BaseFilter _filter2D, opencv_imgproc.BaseRowFilter _rowFilter, opencv_imgproc.BaseColumnFilter _columnFilter, int srcType, int dstType, int bufType, int _rowBorderType, int _columnBorderType, opencv_core.Scalar _borderValue) the full constructor.
FilterEngine(Pointer p)

Method Summary

Modifier and Type	Method and Description
opencv_core.Point	anchor()
opencv_imgproc.FilterEngine	anchor(opencv_core.Point anchor)
void	apply(opencv_core.Mat src, opencv_core.Mat dst)
void	apply(opencv_core.Mat src, opencv_core.Mat dst, opencv_core.Rect srcRoi, opencv_core.Point dstOfs, boolean isolated) applies filter to the specified ROI of the image.
int	borderElemSize()
opencv_imgproc.FilterEngine	borderElemSize(int borderElemSize)
IntPointer	borderTab()
opencv_imgproc.FilterEngine	borderTab(IntPointer borderTab)
int	bufStep()
opencv_imgproc.FilterEngine	bufStep(int bufStep)
int	bufType()
opencv_imgproc.FilterEngine	bufType(int bufType)
int	columnBorderType()
opencv_imgproc.FilterEngine	columnBorderType(int columnBorderType)
opencv_imgproc.BaseColumnFilter	columnFilter()
opencv_imgproc.FilterEngine	columnFilter(opencv_imgproc.BaseColumnFilter columnFilter)
BytePointer	constBorderRow()
opencv_imgproc.FilterEngine	constBorderRow(BytePointer constBorderRow)
BytePointer	constBorderValue()
opencv_imgproc.FilterEngine	constBorderValue(BytePointer constBorderValue)
int	dstType()
opencv_imgproc.FilterEngine	dstType(int dstType)
int	dstY()
opencv_imgproc.FilterEngine	dstY(int dstY)
int	dx1()
opencv_imgproc.FilterEngine	dx1(int dx1)
int	dx2()
opencv_imgproc.FilterEngine	dx2(int dx2)
int	endY()
opencv_imgproc.FilterEngine	endY(int endY)
opencv_imgproc.BaseFilter	filter2D()
opencv_imgproc.FilterEngine	filter2D(opencv_imgproc.BaseFilter filter2D)
void	init(opencv_imgproc.BaseFilter _filter2D, opencv_imgproc.BaseRowFilter _rowFilter, opencv_imgproc.BaseColumnFilter _columnFilter, int srcType, int dstType, int bufType)
void	init(opencv_imgproc.BaseFilter _filter2D, opencv_imgproc.BaseRowFilter _rowFilter, opencv_imgproc.BaseColumnFilter _columnFilter, int srcType, int dstType, int bufType, int _rowBorderType, int _columnBorderType, opencv_core.Scalar _borderValue) reinitializes the engine.
boolean	isSeparable() returns true if the filter is separable
opencv_core.Size	ksize()
opencv_imgproc.FilterEngine	ksize(opencv_core.Size ksize)
int	maxWidth()
opencv_imgproc.FilterEngine	maxWidth(int maxWidth)
opencv_imgproc.FilterEngine	position(int position)
int	proceed(byte[] src, int srcStep, int srcCount, byte[] dst, int dstStep)
int	proceed(ByteBuffer src, int srcStep, int srcCount, ByteBuffer dst, int dstStep)
int	proceed(BytePointer src, int srcStep, int srcCount, BytePointer dst, int dstStep) processes the next srcCount rows of the image.
int	remainingInputRows() returns the number
int	remainingOutputRows()
BytePointer	ringBuf()
opencv_imgproc.FilterEngine	ringBuf(BytePointer ringBuf)
opencv_core.Rect	roi()
opencv_imgproc.FilterEngine	roi(opencv_core.Rect roi)
int	rowBorderType()
opencv_imgproc.FilterEngine	rowBorderType(int rowBorderType)
int	rowCount()
opencv_imgproc.FilterEngine	rowCount(int rowCount)
opencv_imgproc.BaseRowFilter	rowFilter()
opencv_imgproc.FilterEngine	rowFilter(opencv_imgproc.BaseRowFilter rowFilter)
PointerPointer	rows()
opencv_imgproc.FilterEngine	rows(PointerPointer rows)
BytePointer	srcRow()
opencv_imgproc.FilterEngine	srcRow(BytePointer srcRow)
int	srcType()
opencv_imgproc.FilterEngine	srcType(int srcType)
int	start(opencv_core.Mat src)
int	start(opencv_core.Mat src, opencv_core.Rect srcRoi, boolean isolated, int maxBufRows) starts filtering of the specified ROI of the specified image.
int	start(opencv_core.Size wholeSize, opencv_core.Rect roi)
int	start(opencv_core.Size wholeSize, opencv_core.Rect roi, int maxBufRows) starts filtering of the specified ROI of an image of size wholeSize.
int	startY()
opencv_imgproc.FilterEngine	startY(int startY)
int	startY0()
opencv_imgproc.FilterEngine	startY0(int startY0)
opencv_core.Size	wholeSize()
opencv_imgproc.FilterEngine	wholeSize(opencv_core.Size wholeSize)

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

FilterEngine

public FilterEngine(Pointer p)

FilterEngine

public FilterEngine(int size)

FilterEngine

public FilterEngine()

the default constructor

FilterEngine

public FilterEngine(opencv_imgproc.BaseFilter _filter2D,
                    opencv_imgproc.BaseRowFilter _rowFilter,
                    opencv_imgproc.BaseColumnFilter _columnFilter,
                    int srcType,
                    int dstType,
                    int bufType,
                    int _rowBorderType,
                    int _columnBorderType,
                    opencv_core.Scalar _borderValue)

the full constructor. Either _filter2D or both _rowFilter and _columnFilter must be non-empty.

FilterEngine

public FilterEngine(opencv_imgproc.BaseFilter _filter2D,
                    opencv_imgproc.BaseRowFilter _rowFilter,
                    opencv_imgproc.BaseColumnFilter _columnFilter,
                    int srcType,
                    int dstType,
                    int bufType)

Method Detail

position

public opencv_imgproc.FilterEngine position(int position)

Overrides:

position in class Pointer

init

public void init(opencv_imgproc.BaseFilter _filter2D,
                 opencv_imgproc.BaseRowFilter _rowFilter,
                 opencv_imgproc.BaseColumnFilter _columnFilter,
                 int srcType,
                 int dstType,
                 int bufType,
                 int _rowBorderType,
                 int _columnBorderType,
                 opencv_core.Scalar _borderValue)

reinitializes the engine. The previously assigned filters are released.

init

public void init(opencv_imgproc.BaseFilter _filter2D,
                 opencv_imgproc.BaseRowFilter _rowFilter,
                 opencv_imgproc.BaseColumnFilter _columnFilter,
                 int srcType,
                 int dstType,
                 int bufType)

start

public int start(opencv_core.Size wholeSize,
                 opencv_core.Rect roi,
                 int maxBufRows)

starts filtering of the specified ROI of an image of size wholeSize.

start

public int start(opencv_core.Size wholeSize,
                 opencv_core.Rect roi)

start

public int start(opencv_core.Mat src,
                 opencv_core.Rect srcRoi,
                 boolean isolated,
                 int maxBufRows)

starts filtering of the specified ROI of the specified image.

start

public int start(opencv_core.Mat src)

proceed

public int proceed(BytePointer src,
                   int srcStep,
                   int srcCount,
                   BytePointer dst,
                   int dstStep)

processes the next srcCount rows of the image.

proceed

public int proceed(ByteBuffer src,
                   int srcStep,
                   int srcCount,
                   ByteBuffer dst,
                   int dstStep)

proceed

public int proceed(byte[] src,
                   int srcStep,
                   int srcCount,
                   byte[] dst,
                   int dstStep)

apply

public void apply(opencv_core.Mat src,
                  opencv_core.Mat dst,
                  opencv_core.Rect srcRoi,
                  opencv_core.Point dstOfs,
                  boolean isolated)

applies filter to the specified ROI of the image. if srcRoi=(0,0,-1,-1), the whole image is filtered.

apply

public void apply(opencv_core.Mat src,
                  opencv_core.Mat dst)

isSeparable

public boolean isSeparable()

returns true if the filter is separable

remainingInputRows

public int remainingInputRows()

returns the number

remainingOutputRows

public int remainingOutputRows()

srcType

public int srcType()

srcType

public opencv_imgproc.FilterEngine srcType(int srcType)

dstType

public int dstType()

dstType

public opencv_imgproc.FilterEngine dstType(int dstType)

bufType

public int bufType()

bufType

public opencv_imgproc.FilterEngine bufType(int bufType)

ksize

public opencv_core.Size ksize()

ksize

public opencv_imgproc.FilterEngine ksize(opencv_core.Size ksize)

anchor

public opencv_core.Point anchor()

anchor

public opencv_imgproc.FilterEngine anchor(opencv_core.Point anchor)

maxWidth

public int maxWidth()

maxWidth

public opencv_imgproc.FilterEngine maxWidth(int maxWidth)

wholeSize

public opencv_core.Size wholeSize()

wholeSize

public opencv_imgproc.FilterEngine wholeSize(opencv_core.Size wholeSize)

roi

public opencv_core.Rect roi()

roi

public opencv_imgproc.FilterEngine roi(opencv_core.Rect roi)

dx1

public int dx1()

dx1

public opencv_imgproc.FilterEngine dx1(int dx1)

dx2

public int dx2()

dx2

public opencv_imgproc.FilterEngine dx2(int dx2)

rowBorderType

public int rowBorderType()

rowBorderType

public opencv_imgproc.FilterEngine rowBorderType(int rowBorderType)

columnBorderType

public int columnBorderType()

columnBorderType

public opencv_imgproc.FilterEngine columnBorderType(int columnBorderType)

borderTab

public IntPointer borderTab()

borderTab

public opencv_imgproc.FilterEngine borderTab(IntPointer borderTab)

borderElemSize

public int borderElemSize()

borderElemSize

public opencv_imgproc.FilterEngine borderElemSize(int borderElemSize)

ringBuf

public BytePointer ringBuf()

ringBuf

public opencv_imgproc.FilterEngine ringBuf(BytePointer ringBuf)

srcRow

public BytePointer srcRow()

srcRow

public opencv_imgproc.FilterEngine srcRow(BytePointer srcRow)

constBorderValue

public BytePointer constBorderValue()

constBorderValue

public opencv_imgproc.FilterEngine constBorderValue(BytePointer constBorderValue)

constBorderRow

public BytePointer constBorderRow()

constBorderRow

public opencv_imgproc.FilterEngine constBorderRow(BytePointer constBorderRow)

bufStep

public int bufStep()

bufStep

public opencv_imgproc.FilterEngine bufStep(int bufStep)

startY

public int startY()

startY

public opencv_imgproc.FilterEngine startY(int startY)

startY0

public int startY0()

startY0

public opencv_imgproc.FilterEngine startY0(int startY0)

endY

public int endY()

endY

public opencv_imgproc.FilterEngine endY(int endY)

rowCount

public int rowCount()

rowCount

public opencv_imgproc.FilterEngine rowCount(int rowCount)

dstY

public int dstY()

dstY

public opencv_imgproc.FilterEngine dstY(int dstY)

rows

public PointerPointer rows()

rows

public opencv_imgproc.FilterEngine rows(PointerPointer rows)

filter2D

public opencv_imgproc.BaseFilter filter2D()

filter2D

public opencv_imgproc.FilterEngine filter2D(opencv_imgproc.BaseFilter filter2D)

rowFilter

public opencv_imgproc.BaseRowFilter rowFilter()

rowFilter

public opencv_imgproc.FilterEngine rowFilter(opencv_imgproc.BaseRowFilter rowFilter)

columnFilter

public opencv_imgproc.BaseColumnFilter columnFilter()

columnFilter

public opencv_imgproc.FilterEngine columnFilter(opencv_imgproc.BaseColumnFilter columnFilter)