IPindex.gif Previous-2.gif Next-3.gif

IPconvolve


Synopsis

convolve an image with a specified kernel file

Input Ports

in_image

ip_Image

in_roi

ip_Roi

 

Parameters

Kernel

UItext

the kernel name

 

Output Ports

dst

ip_Image_Out

TmpField

IPfld

obj

output renderable object

 

Description

IPconvolve convolves an input image with a specified kernel, producing the filtered output.

Input Ports

in_image
ip_Image. The input image.
in_roi
ip_Roi. An optional region of interest. The data must be of type byte.

Parameters

Kernel Name

String. Name of the kernel. The file <$XP_PATH><0>/data/ip/kernels.ip contains the concatenated list of supplied kernels in the following format:

•      !<name of kernel>

•      KERNEL

•      size <m x n>

•      datatype <type>

•      n lines each of m values

You may add user defined kernels anywhere in this list, but note the "!" delimits one kernel from the next, i.e the above format must be followed carefully.

Output Ports

dst
ip_Image_Out. The output image in a form that other IP modules can process.
TmpField
IPfld. The output image as an AVS/Express field.
out_obj
Renderable object corresponding to dst.

Example

Libraries.Examples.Image_Processing.IPconvolve

File

v/ip.v

See also

Not applicable.

 



IPindex.gif Previous-2.gif Next-3.gif