math:correlation
Version: 0.0.0
Description
Takes two fields and a weighting and computes their correlation: aMb/(||aMa||.||bMb||). If several b fields are provided (via a fields container), correlation is computed for each of them.
Inputs
| Input | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 Required | fieldA | field, double, vector<double> | Field a. The reference field. |
| Pin 1 Required | fieldB | field, fields_container | Field b. If a fields container is provided, correlation is computed for each field. |
| Pin 2 Required | weights | field, fields_container | Field M, optional weighting for correlation computation. |
| Pin 3 Required | absoluteValue | bool | If true, correlation factor is |
Outputs
| Output | Name | Expected type(s) | Description |
|---|---|---|---|
| Pin 0 | field | field | Correlation factor for each input field b. |
| Pin 1 | index | int32 | If several b are provided, this output contains the index of the highest correlation factor. |
Configurations
| Name | Expected type(s) | Default value | Description |
|---|---|---|---|
| mutex | bool | false | If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads. |
Scripting
Category: math
Plugin: core
Scripting name: correlation
Full name: math.correlation
Internal name: correlation
License: any_dpf_supported_increments
Changelog
- Version 0.0.0: Initial release.