Back to Adaptive Vision Studio website

You are here: Start » Filter Reference » Profile Metrics » ProfileCorrelation

ProfileCorrelation


Computes the correlation between two sub-profiles.

Name Type Range Description
inProfile1 Profile First input profile
inStart1 Integer 0 - Start of the first sub-profile of interest
inProfile2 Profile Second input profile
inStart2 Integer 0 - Start of the second sub-profile of interest
inLength Integer* 0 - Length of the sub-profiles of interest
outCorrelation Real Pearson correlation coefficient
outCovariance Real
diagProfile1 Profile First sub-profile of interest
diagProfile2 Profile Second sub-profile of interest

Errors

This filter can throw an exception to report error. Read how to deal with errors here: Error Handling

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.

Complexity Level

This filter is available on Basic Complexity Level.