iwiFilterBox
Syntax
class IwiFilterBoxParams: public ::IwiFilterBoxParams
{
public:
IW_BASE_PARAMS_CONSTRUCTORS(IwiFilterBoxParams, iwiFilterBox_SetDefaultParams)
IwiFilterBoxParams(IwiChDescriptor _chDesc = iwiChDesc_None);
};IW_DECL_CPP(IppStatus) iwiFilterBox(
const IwiImage &srcImage,
IwiImage &dstImage,
IwiSize kernel,
const IwiFilterBoxParams &auxParams = IwiFilterBoxParams(),
const IwiBorderType &border = ippBorderRepl,
const IwiTile &tile = IwiTile()
)
Parameters
- srcImage
- Reference to the source image.
- dstImage
- Reference to the destination image.
- kernel
- Size of the filter kernel.
- auxParams
- Reference to the auxiliary parameters structure.
- border
- Extrapolation algorithm for out of image pixels processing. Supported values:
- ippBorderConst
- Values of all border pixels are set to a constant.
- ippBorderRepl
- Border is replicated from the edge pixels.
- ippBorderInMem
- Border is obtained from the source image pixels in memory.
- ippBorderMirror
- Border pixels are mirrored from the source image boundary pixels.
- tile
- Reference to theIwiTilestructure for tiling. By default, no tiling is applied.
Auxiliary Arguments
Argument | Default Value | Description |
|---|---|---|
chDesc | iwiChDesc_None | Special channels processing mode. |
Description
This function performs box filtering of an image.
This function supports the following features:
Feature | Support |
|---|---|
Data types | 8u , 16u , 16s , 32f |
Channel types | C1, C3, C4, C4M1110 |
In-place mode | No |
64-bit sizes | No |
Internal threading | No |
Manual tiling | Yes |
IwsTile simple tiling | Yes |
IwsTile pipeline tiling | Yes |
Return Values
- ippStsNoErr
- No errors.
Exception Values
- ippStsBorderErr
- Thebordervalue is illegal.
- ippStsDataTypeErr
- ThedataTypevalue is illegal.
- ippStsNumChannelsErr
- The value for channels is illegal.
- ippStsNotEvenStepErr
- The step value is not divisible by size of elements.
- ippStsNotSupportedModeErr
- The selected function mode is not supported.
- ippStsInplaceModeNotSupportedErr
- In-place operation is not supported:pSrcis equal topDst.
- ippStsNullPtrErr
- At least one of the pointers (exceptpTile) isNULL.