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

Invoke.ProfileCorrelation

Computes the correlation between two sub-profiles.

Namespace:Avl
Assembly:AvlNet.dll

Syntax

C++
C#
 
public static void ProfileCorrelation
(
	Avl.Profile inProfile1,
	int inStart1,
	Avl.Profile inProfile2,
	int inStart2,
	Optional<int> inLength,
	out float outCorrelation,
	Optional<float> outCovariance,
	Diagnostic<Avl.Profile> diagProfile1,
	Diagnostic<Avl.Profile> diagProfile2
)

Parameters

Name Type Range Default Description
inProfile1Avl.ProfileFirst input profile.
inStart1int<0, INF>Start of the first sub-profile of interest.
inProfile2Avl.ProfileSecond input profile.
inStart2int<0, INF>Start of the second sub-profile of interest.
inLengthAtl.Optional<int><0, INF>Length of the sub-profiles of interest. Default value: atl::NIL.
outCorrelationfloatPearson correlation coefficient.
outCovarianceAtl.Optional<float>
diagProfile1Avl.Diagnostic<Avl.Profile>First sub-profile of interest.
diagProfile2Avl.Diagnostic<Avl.Profile>Second sub-profile of interest.

See also