You are here: Start » FIL.NET » FIL.ConvolveProfile
FIL.ConvolveProfile
Applies a user-defined convolution to a profile.
| Namespace: | FilNet |
|---|---|
| Assembly: | FIL.NET.dll |
Syntax
C++
C#
public static void ConvolveProfile ( FilNet.Profile inProfile, FilNet.Range? inRange, IList<float> inMask, bool inNormalizeMaskValues, int? inMaskOrigin, FilNet.Profile outProfile )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inProfile | FilNet.Profile | Profile to be processed. | ||
| inRange | FilNet.Range? | |||
| inMask | System.Collections.Generic.IList<float> | Convolution kernel mask that will be applied to the profile. | ||
| inNormalizeMaskValues | bool | False | If set to true, the kernel mask will be normalized so that its values sum up to one. Default value: False. | |
| inMaskOrigin | int? | Index of the kernel mask element that will be aligned against the profile values. Default value: ftl::NIL. | ||
 | outProfile | FilNet.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
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. |
