oph_gsl_correlation

Description

Behaviour

It computes the Pearson coefficient of two measure arrays. NOTE: the two measures must have the same type and length.

Parameters

  • input measure type: Ophidia typing. Supported types are pairs of: ‘oph_double’; ‘oph_float’; ‘oph_long’; ‘oph_int’; ‘oph_short’; ‘oph_byte’.
  • output measure type: Ophidia typing. Supported types are: ‘oph_double’; ‘oph_float’; ‘oph_long’; ‘oph_int’; ‘oph_short’; ‘oph_byte’.
  • measure: input measure.
  • measure2: second input measure.

Return type

Binary-array.

Examples

Compute correlation of the two measures.

oph_gsl_correlation('OPH_DOUBLE|OPH_DOUBLE','OPH_DOUBLE',a.measure,b.measure)

Operation type

Reduce.

Arguments

Argument name Type Mandatory Values Default Min/Max-value Min/Max-times
input measure type “oph_type” “yes” “‘oph_double’|’oph_float’|’oph_int’|’oph_long’|’oph_short’|’oph_byte’”     “1” / “1”
output measure type “oph_type” “yes” “‘oph_double’|’oph_float’|’oph_int’|’oph_long’|’oph_short’|’oph_byte’”     “1” / “1”
measure “binary-array” “yes”       “1” / “1”
measure2 “binary-array” “yes”       “1” / “1”