Start » Filter Reference » Profile » Profile Local Transforms » ConvolveProfile

ConvolveProfile


Module: FoundationPro

Applies a user-defined convolution to a profile.

Name Type Description
Input value
inProfile Profile Profile to be processed
Input value
inRange Range*
Input value
inMask RealArray Convolution kernel mask that will be applied to the profile
Input value
inNormalizeMaskValues Bool If set to true, the kernel mask will be normalized so that its values sum up to one
Input value
inMaskOrigin Integer* Index of the kernel mask element that will be aligned against the profile values
Output value
outProfile Profile Output profile

Description

The operation computes each value as a convolution of inProfile and inMask values. Values which mask exceeds profile dimension are set to zero.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Convolution mask is empty in ConvolveProfile.
DomainError Mask origin exceeds dimensions of convolution mask in ConvolveProfile.
DomainError Normalization of kernel mask which values add up to zero was requested in ConvolveProfile.
DomainError Range exceeds the input profile in ConvolveProfile.

Complexity Level

This filter is available on Advanced Complexity Level.