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,
int? inLength,
out float outCorrelation,
out float outCovariance
)
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. |
| inLength | int? | <0, INF> | | Length of the sub-profiles of interest. Default value: atl::NIL, or null. |
| outCorrelation | float | | | Pearson correlation coefficient. |
| outCovariance | float | | | |
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. |
See also