Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Basic » Statistics » PearsonCorrelation

PearsonCorrelation

Advanced

Module: FoundationLite

Computes Pearson product-moment correlation coefficient. The array must be not empty.

Name Type Range Description
Input value inValues1 RealArray Array of values of the first variable
Input value inValues2 RealArray Array of values of the second variable
Input value inMinStdDev Real 0.0 - Minimum value of standard deviation for correlation to be non-zero
Output value outCorrelation Real Computed correlation coefficient between two variables

Hints

  • Make sure that the standard deviation of both input arrays is non-zero.

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 Cannot compute the value of PearsonCorrelation. The standard deviation of some set of input values is equal to zero.
DomainError Empty array on input in PearsonCorrelation.
DomainError Inconsistent size of arrays in PearsonCorrelation.

Complexity Level

This filter is available on Advanced Complexity Level.