Note

Click here to download the full example code

# Estimate Sobol’ indices for a function with multivariate output¶

In this example, we estimate the Sobol’ indices of a function by sampling methods. This function has several outputs, which leads to the need of aggregated Sobol’ indices.

## Introduction¶

In this example we quantify the sensitivity of a function’s outputs to its inputs with Sobol’ indices.

The function we consider has 5 outputs. In this case, it may be convenient to consider each output separately. It may also be interesting to aggregate the sensitivity indices to get a global understanding of the sensitivity of the inputs to the average output.

## Define the model¶

```
import openturns as ot
import openturns.viewer
import openturns.viewer as viewer
ot.Log.Show(ot.Log.NONE)
```

We define a linear model with 5 independent Gaussian inputs and 2 ouputs.

```
inputDistribution = ot.Normal(5)
function = ot.SymbolicFunction(['x0', 'x1', 'x2', 'x3', 'x4'],
['x0 + 4.0 * x1 ^ 2 + 3.0 * x2',
'-7.0 * x2 - 4.0 * x3 + x4'])
```

## Estimate the Sobol’ indices¶

We first create a design of experiments with SobolIndicesExperiment.

```
size = 1000
sie = ot.SobolIndicesExperiment(inputDistribution, size)
inputDesign = sie.generate()
input_names = inputDistribution.getDescription()
inputDesign.setDescription(input_names)
print("Sample size: ", inputDesign.getSize())
```

Out:

```
Sample size: 7000
```

We see that 7000 function evaluations are required to estimate the first order and total Sobol’ indices. Then we evaluate the outputs corresponding to this design of experiments.

```
outputDesign = function(inputDesign)
```

Then we estimate the Sobol’ indices with the SaltelliSensitivityAlgorithm.

```
sensitivityAnalysis = ot.SaltelliSensitivityAlgorithm(inputDesign, outputDesign, size)
```

The getFirstOrderIndices and getTotalOrderIndices method respectively return estimates of first order and total Sobol’ indices with a given output. Since these depend on the output marginal, the index of the output must be specified (the default is to return the index for the first output).

```
output_dimension = function.getOutputDimension()
for i in range(output_dimension):
print("Output #", i)
first_order = sensitivityAnalysis.getFirstOrderIndices(i)
total_order = sensitivityAnalysis.getTotalOrderIndices(i)
print(" First order indices: ", first_order)
print(" Total order indices: ", total_order)
agg_first_order = sensitivityAnalysis.getAggregatedFirstOrderIndices()
agg_total_order = sensitivityAnalysis.getAggregatedTotalOrderIndices()
print("Agg. first order indices: ", agg_first_order)
print("Agg. total order indices: ", agg_total_order)
```

Out:

```
Output # 0
First order indices: [0.0193485,0.926175,0.214315,0.0073664,0.0073664]
Total order indices: [0.0257704,0.752385,0.21691,-6.95879e-07,-6.95879e-07]
Output # 1
First order indices: [-0.0386219,-0.0386219,0.669372,0.207858,-0.0343933]
Total order indices: [-1.11308e-07,-1.11308e-07,0.756054,0.268296,0.014661]
Agg. first order indices: [-0.0163697,0.33172,0.494696,0.130898,-0.0183636]
Agg. total order indices: [0.00989204,0.288806,0.549101,0.165309,0.00903306]
```

We see that:

x1 has a rather large first order index on the first output, but a small index on the second output,

x2 has a rather large first order index on the first output on both outputs,

the largest aggregated Sobol’ index is x2,

x0 and x5 have Sobol’ indices which are close to zero regardless of whether the indices are aggregated or not.

The draw method produces the following graph. The vertical bars represent the 95% confidence intervals of the estimates.

```
graph = sensitivityAnalysis.draw()
view = viewer.View(graph)
```

Since there are several outputs, the graph presents the aggregated Sobol’ indices. The aggregated Sobol’ indices indicate that the input variable which has the largest impact on the variability of the several outputs is x2.

**Total running time of the script:** ( 0 minutes 0.156 seconds)