You are here: Start » AVL.NET » 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 )
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. | ||
outCorrelation | float | Pearson correlation coefficient. | |||
outCovariance | float |
Hardware Acceleration
This operation is optimized for AVX2 technology.
Hardware acceleration settings may be manipulated with Settings class.
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
- ProfileCorrelation(Profile, Int32, Profile, Int32, Single)
- ProfileCorrelation(Profile, Int32, Profile, Int32, Single, Single)
- ProfileCorrelation(Profile, Int32, Profile, Int32, Nullable<Int32>, Single)
- ProfileCorrelation(Profile, Int32, Profile, Int32, Single, Profile, Profile)
- ProfileCorrelation(Profile, Int32, Profile, Int32, Single, Single, Profile, Profile)
- ProfileCorrelation(Profile, Int32, Profile, Int32, Nullable<Int32>, Single, Profile, Profile)
- ProfileCorrelation(Profile, Int32, Profile, Int32, Nullable<Int32>, Single, Single, Profile, Profile)