## On this page

  

 

 # math:correlation

 Last update: 31.07.2026 

**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

This table lists the input pins for this operator. Input pins define the data that the operator requires to perform its operation. Some inputs are required, while others are optional and provide additional configuration. Each parameter is detailed in the sections that follow the table.

Pin numberNameStatusExpected type(s)0[fieldA](#input_0)Required[`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector<double>`](../../core-concepts/dpf-types.md#standard-types)**1**[fieldB](#input_1)Required[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)**2**[weights](#input_2)Required[`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)**3**[absoluteValue](#input_3)Required[`bool`](../../core-concepts/dpf-types.md#standard-types)<a id="input_0"></a>

### fieldA (Pin 0)

- **Required:** Yes
- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`double`](../../core-concepts/dpf-types.md#standard-types), [`vector<double>`](../../core-concepts/dpf-types.md#standard-types)

Field a. The reference field.

<a id="input_1"></a>

### fieldB (Pin 1)

- **Required:** Yes
- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

Field b. If a fields container is provided, correlation is computed for each field.

<a id="input_2"></a>

### weights (Pin 2)

- **Required:** Yes
- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field), [`fields_container`](../../core-concepts/dpf-types.md#fields-container)

Field M, optional weighting for correlation computation.

<a id="input_3"></a>

### absoluteValue (Pin 3)

- **Required:** Yes
- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)

If true, correlation factor is ||aMb||/(||aMa||.||bMb||)

## Outputs

This table lists the output pins for this operator. Output pins provide the results of the operator's computation and can be connected to inputs of other operators or retrieved for further processing. Each output is detailed in the sections that follow the table.

Pin numberNameExpected type(s)0[field](#output_0)[`field`](../../core-concepts/dpf-types.md#field)**1**[index](#output_1)[`int32`](../../core-concepts/dpf-types.md#standard-types)<a id="output_0"></a>

### field (Pin 0)

- **Expected type(s):** [`field`](../../core-concepts/dpf-types.md#field)

Correlation factor for each input field b.

<a id="output_1"></a>

### index (Pin 1)

- **Expected type(s):** [`int32`](../../core-concepts/dpf-types.md#standard-types)

If several b are provided, this output contains the index of the highest correlation factor.

## Configurations

This operator supports [configuration options](../../core-concepts/operator-configurations.md) that modify its behavior.

### [mutex](../../core-concepts/operator-configurations.md#mutex)

- **Expected type(s):** [`bool`](../../core-concepts/dpf-types.md#standard-types)
- **Default value:** false

If this option is set to true, the shared memory is prevented from being simultaneously accessed by multiple threads.

## Scripting

This operator can be accessed through scripting interfaces using these identifiers.

**Category**: math

**Plugin**: core

**Scripting name**: correlation

**Full name**: math.correlation

**Internal name**: correlation

**License**: any\_dpf\_supported\_increments

## Examples

These examples demonstrate how to use this operator in different programming environments. Each example shows how to instantiate the operator, connect the required inputs, and retrieve the output.

C++```cpp
#include "dpf_api.h"

ansys::dpf::Operator op("correlation"); // operator instantiation
op.connect(0, my_fieldA);
op.connect(1, my_fieldB);
op.connect(2, my_weights);
op.connect(3, my_absoluteValue);
ansys::dpf::Field my_field = op.getOutput<ansys::dpf::Field>(0);
int my_index = op.getOutput<int>(1);

```

CPython```python
import ansys.dpf.core as dpf

op = dpf.operators.math.correlation() # operator instantiation
op.inputs.fieldA.connect(my_fieldA)
op.inputs.fieldB.connect(my_fieldB)
op.inputs.weights.connect(my_weights)
op.inputs.absoluteValue.connect(my_absoluteValue)
my_field = op.outputs.field()
my_index = op.outputs.index()

```

IPython```python
import mech_dpf
import Ans.DataProcessing as dpf

op = dpf.operators.math.correlation() # operator instantiation
op.inputs.fieldA.Connect(my_fieldA)
op.inputs.fieldB.Connect(my_fieldB)
op.inputs.weights.Connect(my_weights)
op.inputs.absoluteValue.Connect(my_absoluteValue)
my_field = op.outputs.field.GetData()
my_index = op.outputs.index.GetData()

```

  
## Changelog

- Version 0.0.0: Initial release.