F_VN_BoxFilterExp

F_VN_BoxFilterExp 1:

Apply a box filter to an image. (expert function)

Syntax

Definition:

FUNCTION F_VN_BoxFilterExp : HRESULT
VAR_INPUT
    ipSrcImage    : ITcVnImage;
    ipDestImage   : Reference To  ITcVnImage;
    nFilterWidth  : UDINT;
    nFilterHeight : UDINT;
    eDestDepth    : ETcVnElementType;
END_VAR
VAR_IN_OUT
    aAnchor       : TcVnPoint;
END_VAR
VAR_INPUT
    bNormalize    : BOOL;
    eBorderType   : ETcVnBorderInterpolationMethod;
    hrPrev        : HRESULT;
END_VAR

F_VN_BoxFilterExp 2: Inputs

Name

Type

Description

ipSrcImage

ITcVnImage

Source image

ipDestImage

Reference To ITcVnImage

Destination image (An appropriate destination image will be created if required.)

nFilterWidth

UDINT

Filter width in pixels

nFilterHeight

UDINT

Filter height in pixels

eDestDepth

ETcVnElementType

Destination image depth

bNormalize

BOOL

If true, the kernel is normalized by nFilterWidth * nFilterHeight

eBorderType

ETcVnBorderInterpolationMethod

Image border handling

hrPrev

HRESULT

HRESULT indicating the result of previous operations (If SUCCEEDED(hrPrev) equals false, no operation is executed.)

F_VN_BoxFilterExp 3: In/Outputs

Name

Type

Description

aAnchor

TcVnPoint

Anchor point of the kernel ([-1, -1] for center)

F_VN_BoxFilterExp 4: Return value

HRESULT

Required License

TC3 Vision Base

System Requirements