ProfileCorrelation


Computes the correlation between two sub-profiles.

Syntax

C++
C#
Python
 
def ProfileCorrelation(
	inProfile1: Profile,
	inProfile2: Profile,
	/,
	*,
	inStart1: int = 0,
	inStart2: int = 0,
	inLength: int | None = None,
	diagProfile1: Profile | None = None,
	diagProfile2: Profile | None = None
)
-> (
	outCorrelation: float,
	outCovariance: float
)

Parameters

Name Type Range Default Description
Input value inProfile1 Profile First input profile
Input value inStart1 int 0 - 0 Start of the first sub-profile of interest
Input value inProfile2 Profile Second input profile
Input value inStart2 int 0 - 0 Start of the second sub-profile of interest
Input value inLength int | None 0 - None Length of the sub-profiles of interest
Output value outCorrelation float Pearson correlation coefficient
Output value outCovariance float
Diagnostic input diagProfile1 Profile | None None First sub-profile of interest
Diagnostic input diagProfile2 Profile | None None Second sub-profile of interest

Hardware Acceleration

This operation is optimized for AVX2 technology.

This operation is optimized for NEON technology.