You are here: Start » AVL.NET » AVL.ProfileCorrelation Method
AVL.ProfileCorrelation Method
Computes the correlation between two sub-profiles.
| Namespace: | AvlNet |
|---|---|
| Assembly: | AVL.NET.dll |
Syntax
public static void ProfileCorrelation( AvlNet.Profile inProfile1, int inStart1, AvlNet.Profile inProfile2, int inStart2, out float outCorrelation, out float outCovariance, out AvlNet.Profile diagProfile1, out AvlNet.Profile diagProfile2 )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
 | inProfile1 | AvlNet.Profile | First input profile. | ||
| inStart1 | int | <0, INF> | Start of the first sub-profile of interest. | |
| inProfile2 | AvlNet.Profile | Second input profile. | ||
| inStart2 | int | <0, INF> | Start of the second sub-profile of interest. | |
 | outCorrelation | float | Pearson correlation coefficient. | ||
| outCovariance | float | |||
 | diagProfile1 | AvlNet.Profile | First sub-profile of interest. | ||
| diagProfile2 | AvlNet.Profile | Second sub-profile of interest. |
Errors
| Error type | Description |
|---|---|
| DomainError | Empty profiles on input in ProfileCorrelation. |
| DomainError | At least two element sub-profiles are required in ProfileCorrelation. |
| DomainError | First sub-profile is out of range in ProfileCorrelation. |
| DomainError | Second sub-profile is out of range in ProfileCorrelation. |
