You are here: Start » AVL.NET » AVL.ProfileCorrelation

AVL.ProfileCorrelation

Computes the correlation between two sub-profiles.

Namespace:AvlNet
Assembly:AVL.NET.dll

Syntax

C++
C#
 
public static void ProfileCorrelation
(
	AvlNet.Profile inProfile1,
	int inStart1,
	AvlNet.Profile inProfile2,
	int inStart2,
	int? inLength,
	out float outCorrelation,
	out float outCovariance,
	AvlNet.Profile diagProfile1,
	AvlNet.Profile diagProfile2
)

Parameters

Name Type Range Default Description
inProfile1AvlNet.ProfileFirst input profile.
inStart1int<0, INF>Start of the first sub-profile of interest.
inProfile2AvlNet.ProfileSecond input profile.
inStart2int<0, INF>Start of the second sub-profile of interest.
inLengthint?<0, INF>Length of the sub-profiles of interest. Default value: atl::NIL.
outCorrelationfloatPearson correlation coefficient.
outCovariancefloat
diagProfile1AvlNet.ProfileFirst sub-profile of interest.
diagProfile2AvlNet.ProfileSecond sub-profile of interest.

Errors

List of possible exceptions:

Error type Description
DomainError At least two element sub-profiles are required in ProfileCorrelation.
DomainError Empty profiles on input in ProfileCorrelation.
DomainError First sub-profile is out of range in ProfileCorrelation.
DomainError Second sub-profile is out of range in ProfileCorrelation.

Function Overrides

See also