You are here: Start » AVL.NET » AVL.ConvolveProfile(AvlNet.Profile, float[], bool, int?, AvlNet.Profile)

AVL.ConvolveProfile(AvlNet.Profile, float[], bool, int?, AvlNet.Profile)

Applies a user-defined convolution to a profile.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax


public static void ConvolveProfile(
	AvlNet.Profile inProfile,
	float[] inMask,
	bool inNormalizeMaskValues,
	int? inMaskOrigin,
	out AvlNet.Profile outProfile
)

Parameters

inProfile
Type: AvlNet.Profile
Profile to be processed
inMask
Type: System.Single
Convolution kernel mask that will be applied to the profile
inNormalizeMaskValues
Type: System.Boolean
If set to true, the kernel mask will be normalized so that its values sum up to one
inMaskOrigin
Type: System.Nullable<System.Int32>
Index of the kernel mask element that will be aligned against the profile values, or null.
outProfile
Type: AvlNet.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

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.

See also