Filters an image using a spatial kernel that consists of a single row.
Syntax
Case 1: Operation on integer data
IppStatus ippiFilterRow_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize dstRoiSize, const Ipp32s* pKernel, int kernelSize, int xAnchor, int divisor);
Supported values for mod:
| 8u_C1R | 16u_C1R | 16s_C1R |
| 8u_C3R | 16u_C3R | 16s_C3R |
| 8u_C4R | 16u_C4R | 16s_C4R |
| 8u_AC4R | 16u_AC4R | 16s_AC4R |
Case 2: Operation on floating-point data
IppStatus ippiFilterRow_<mod>(const Ipp<datatype>* pSrc, int srcStep, Ipp<datatype>* pDst, int dstStep, IppiSize dstRoiSize, const Ipp32f* pKernel, int kernelSize, int xAnchor);
Supported values for mod:
| 32f_C1R | 64f_C1R |
| 32f_C3R | |
| 32f_C4R | |
| 32f_AC4R |
Parameters
pSrc |
Pointer to the source image ROI. |
srcStep |
Distance in bytes between starts of consecutive lines in the source image. |
pDst |
Pointer to the destination image ROI. |
dstStep |
Distance in bytes between starts of consecutive lines in the destination image. |
dstRoiSize |
Size of the source and destination ROI in pixels. |
pKernel |
Pointer to the kernel values. |
kernelSize |
Size of the kernel in pixels. |
xAnchor |
Anchor cell specifying the kernel horizontal alignment with respect to the position of the input pixel. |
divisor |
The integer value by which the computed result is divided (for operations on integer data only). |
Description
The function ippiFilterRow is declared in the ippi.h file. It operates with ROI (see Regions of Interest in Intel IPP).
This function uses the horizontal row kernel of size kernelSize to filter an image. This function sums the products between the kernel coefficients pKernel and pixel values taken over the source pixel neighborhood defined by kernelSize and xAnchor. Note that kernel coefficients are used in inverse order.
The sum is written to the destination pixel. In case of integer data, the result is divided by the fixed scaling factor divisor. To ensure valid operation when image boundary pixels are processed, the application should correctly define additional border pixels (see Borders).
For function flavors that operate on integer data, the result value for pixel Xi,j inside image's ROI is computed according to the following formula:
where
Kn are the kernel values;
W = kernelSize is the size of the horizontal row kernel;
Q = W - xAnchor - 1.
Function flavors that accept input data of the Ipp32f type use the same summation formula, but no scaling of the result is done.
Return Values
ippStsNoErr |
Indicates no error. Any other value indicates an error. |
ippStsNullPtrErr |
Indicates an error condition if pSrc, pDst, orpKernel is NULL. |
ippStsSizeErr |
Indicates an error condition if dstRoiSize has a field with a zero or negative value. |
ippStsDivisorErr |
Indicates an error condition if the divisor value is zero. |