Back to Aurora Vision Studio website

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

ProfileCorrelation


Module: FoundationPro

Computes the correlation between two sub-profiles.

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

Hardware Acceleration

This operation is optimized for AVX2 technology.

This operation is optimized for NEON technology.

Errors

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

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.

Complexity Level

This filter is available on Basic Complexity Level.