iwiFilterSobel
iwiFilterSobel
Syntax
class IwiFilterSobelParams: public ::IwiFilterSobelParams
{
public:
IW_BASE_PARAMS_CONSTRUCTORS(IwiFilterSobelParams, iwiFilterSobel_SetDefaultParams)
IwiFilterSobelParams() {}
};
IW_DECL_CPP(IppStatus) iwiFilterSobel(
const IwiImage &srcImage,
IwiImage &dstImage,
IwiDerivativeType opType,
IppiMaskSize kernelSize = ippMskSize3x3,
const IwiFilterSobelParams &auxParams = IwiFilterSobelParams(),
const IwiBorderType &border = ippBorderRepl,
const IwiTile &tile = IwiTile()
);
Parameters
- srcImage
- Reference to the source image.
- dstImage
- Reference to the destination image.
- opType
- Type of the Sobel operator fromIwFilterSobelType.
- kernelSize
- Size of the filter kernel. Supported values:ippMskSize3x3,ippMskSize5x5
- 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.
- ippBorderMirror
- Border pixels are mirrored from the source image boundary pixels.
- ippBorderInMem
- Border is obtained from the source image pixels in memory.
- tile
- Reference to theIwiTileobject for tiling. By default, no tiling is used.
Description
This function applies a Sobel filter of the specified type and kernel size to the source image. The values of border pixels are assigned in accordance with the
border
and borderValue
parameters. The kernel of the filter is a matrix of 3x3 or 5x5 size depending on the kernelSize
value.Return Values
- ippStsNoErr
- No errors.
Exception Values
- ippStsNotSupportedModeErr
- Specified combination of parameters' values is not supported.
- ippStsMaskSizeErr
- Thekernelvalue is illegal.
- ippStsDataTypeErr
- ThedataTypevalue is illegal.
- ippStsNumChannelsErr
- Thechannelsvalue is illegal.
- ippStsNotEvenStepErr
- ThesrcStepand/ordstStepvalue is not divisible by size of elements.
- ippStsBorderErr
- Thebordervalue is illegal.
- ippStsNoMemErr
- Failed to allocate memory.
- ippStsSizeErr
- Values of thesizefields are illegal.
- ippStsInplaceModeNotSupportedErr
- In-place operation is not supported:pSrcis equal topDst.
- ippStsNullPtrErr
- At least one of the pointers (excepttile) isNULL.