F_VN_SeparableCustomFilterExp

Syntax

Definition:

FUNCTION F_VN_SeparableCustomFilterExp : HRESULT
VAR_INPUT
    ipSrcImage  : ITcVnImage;
    ipDestImage : Reference To  ITcVnImage;
    eDestDepth  : ETcVnElementType;
END_VAR
VAR_IN_OUT
    stKernelX   : TcVnMatrix;
    stKernelY   : TcVnMatrix;
    aAnchor     : TcVnPoint;
END_VAR
VAR_INPUT
    fDelta      : LREAL;
    eBorderType : ETcVnBorderInterpolationMethod;
    hrPrev      : HRESULT;
END_VAR

Inputs

Name	Type	Description
ipSrcImage	ITcVnImage	Source image
ipDestImage	Reference To ITcVnImage	Destination image (An appropriate destination image will be created if required.)
eDestDepth	ETcVnElementType	Destination image depth
fDelta	LREAL	Value added to each pixel after filtering
eBorderType	ETcVnBorderInterpolationMethod	Image border handling
hrPrev	HRESULT	HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

In/Outputs

Name	Type	Description
stKernelX	TcVnMatrix	1D custom row-filter kernel with values of type REAL or LREAL
stKernelY	TcVnMatrix	1D custom column-filter kernel with values of type REAL or LREAL
aAnchor	TcVnPoint	Anchor point of the kernel

Return value

HRESULT

Further information

The function F_VN_SeparableCustomFilterExp is the Expert version of F_VN_SeparableCustomFilter. It contains additional parameters.

Parameter

Input image

The input image ipSrcImage may have any available format.

Result image

The result image ipDestImage has the same size as the input image ipSrcImage, but the pixel format is determined by the result depth eDestDepth.

X and Y kernel

The two 1-dimensional filter kernels stKernelX and stKernelY are transferred as a matrix. Permitted element types of the matrix are TCVN_ET_REAL and TCVN_ET_LREAL. Corresponding matrices of the type TcVnMatrix can be created with the aid of the function F_VN_InitMatrixStruct.

Anchor point

The anchor point aAnchor defines which point of the filter kernel is moved over each pixel of the input image ipSrcImage.

Delta

The constant delta fDelta is added to the result of the filter operation.

Border extrapolation

The method of border extrapolation eBorderType defines how non-existent pixels are extrapolated beyond the image border in order to calculate the filter values at the image borders. For further details, see ETcVnBorderInterpolationMethod.

Application

hr := F_VN_SeparableCustomFilterExp(
    ipSrcImage  :=  ipImageIn,
    ipDestImage :=  ipImageRes,
    eDestDepth  :=  TCVN_ET_USINT,
    stKernelX   :=  stKernelMatrixX, 
    stKernelY   :=  stKernelMatrixY,
    aAnchor     :=  aAnchorPoint,
    fDelta      :=  0,
    eBorderType :=  TCVN_BIM_DEFAULT,
    hrPrev      :=  hr
);