BoxFilter

Apply a box filter to an image.

Syntax

Definition:

HRESULT BoxFilter(
    HRESULT                        hrPrev,
    ITcVnImage*                    ipSrcImage,
    ITcVnImage*&                   ipDestImage,
    ULONG                          nFilterWidth,
    ULONG                          nFilterHeight,
    ETcVnElementType               eDestDepth = TCVN_ET_SAME_AS_SOURCE,
    TcVnPoint&                     aAnchor = {-1, -1},
    bool                           bNormalize = true,
    ETcVnBorderInterpolationMethod eBorderType = BIM_DEFAULT
)

Parameters

Name

Type

Default

Description

hrPrev

HRESULT

 

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

ipSrcImage

ITcVnImage*

 

Source image

ipDestImage

ITcVnImage*&

 

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

nFilterWidth

ULONG

 

Filter width in pixels

nFilterHeight

ULONG

 

Filter height in pixels

eDestDepth

ETcVnElementType

TCVN_ET_SAME_AS_SOURCE

Destination image depth

aAnchor

TcVnPoint&

{-1, -1}

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

bNormalize

bool

true

If true, the kernel is normalized by nFilterWidth * nFilterHeight

eBorderType

ETcVnBorderInterpolationMethod

BIM_DEFAULT

Image border handling

BoxFilter 1: Return value

HRESULT

Required License

TC3 Vision Base

System Requirements

Development environment

Target platform

PLC libraries to include

TwinCAT V3.1.4024.54 or later

PC or CX (x64) with PL50, e.g. Intel 4-core Atom CPU

Tc3_Vision