/usr/include/openturns/swig/SimulationSensitivityAnalysis_doc.i is in libopenturns-dev 1.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 | %feature("docstring") OT::SimulationSensitivityAnalysis
"Class to perform a sensitivity analysis based on a reliability event.
Available constructor:
SimulationSensitivityAnalysis(*inputSample, outputSample, transformation, comparisonOp, threshold*)
SimulationSensitivityAnalysis(*event*)
SimulationSensitivityAnalysis(*simulationRes*)
Parameters
----------
inputSample, outputSample : 2-d sequence of float
Input sample and output sample of a model evaluated apart.
transformation : :class:`~openturns.NumericalMathFunction`
An isoprobabilistic transformation function.
comparisonOp : :class:`~openturns.ComparisonOperator`
A comparison operator.
threshold : float
A threshold.
event : :class:`~openturns.Event`
An event which it composite (test is with the method
:meth:`isComposite <openturns.Event.isComposite>`).
simulationRes : :class:`~openturns.SimulationResult`
A simulation result.
Notes
-----
The simulation sensitivity analysis is based on:
- in the first usage, the *inputSample* and *outputSample* given:
- in the second usage, the samples which have been stored by the function
defining the event. Care if the sample is not a statistical sample: post
treatment proposed by the object might not be right.
- in the third usage, the samples generated by the
:class:`simulation <openturns.Simulation>` that produced *simulationRes*."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::computeImportanceFactors
"Compute the importance factors.
Returns
-------
impFactors : :class:`~openturns.NumericalPoint`
The importance factors.
Notes
-----
The importance factors, given in :eq:`importance_factor`, are evaluated from the
coordinates of the mean point :eq:`mean_point` of the event domain, mapped into
the standard space as follows:
.. math::
:label: mean_point
\\\\vect{X}^*_{event} = \\\\frac{1}{n} \\\\sum_{i=1}^n \\\\vect{X}_i 1_{event} (\\\\vect{X}_i)
.. math::
:label: importance_factor
\\\\alpha_i = \\\\frac{ (U_i^*)^2 }{ \\\\left\\\\| \\\\vect{U}^* \\\\right\\\\| }
where
.. math::
\\\\vect{U}^* = T(\\\\vect{X}^*_{event})
Be careful: this notion is only valid for :class:`~openturns.MonteCarlo` or
:class:`~openturns.LHS` sampling as the mean is evaluated from the equation
:eq:`importance_factor` (only uniform weights over the realizations
:math:`\\\\vect{X}_i`."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::computeMeanPointInEventDomain
"Accessor to the mean point.
Returns
-------
mean : :class:`~openturns.NumericalPoint`
The mean point in the failure domain.
Notes
-----
This method computes the mean point in the physical space of all the simulations
generated by the simulation that failed into the event domain.
Be carefull: this notion is only valid for Monte Carlo or LHS sampling as the
mean is evaluated from the equation :eq:`mean_point` (only uniform weights over
the realizations :math:`\\\\vect{X}_i`."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::drawImportanceFactors
"Draw the importance factors.
Returns
-------
graph : :class:`~openturns.Graph`
Graph containing the pie corresponding to the importance factors of the probabilistic variables."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::drawImportanceFactorsRange
"Draw the importance factors evolution.
Parameters
----------
probabilityScale : boolean
Set True if the limits are the probability levels; set False if the limits are
the thresholds defining the event.
lower, upper : floats
Define the boundaries of the probability levels :math:`p_{min}` and
:math:`p_{max}` or those of the thresholds :math:`s_{min}` and :math:`s_{max}`.
Returns
-------
graph : :class:`~openturns.Graph`
A graph that draws the evolution of the importance factors of each direction
with respect to :math:`p \\\\in [p_{min}, p_{max}]` or
:math:`s \\\\in [s_{min}, s_{max}]`. The importance factors are evaluated from
the definition :eq:`importance_factor` for each threshold *s* or probability
*p*."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::getComparisonOperator
"Accessor to the comparison operator.
Returns
-------
operator : :class:`~openturns.ComparisonOperator`
The comparison operator."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::getInputSample
"Accessor to the input sample.
Returns
-------
inputSample : :class:`~openturns.NumericalSample`
The input sample."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::getOutputSample
"Accessor to the output sample.
Returns
-------
outputSample : :class:`~openturns.NumericalSample`
The output sample."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::getThreshold
"Accessor to the threshold.
Returns
-------
s : float
The threshold."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::getTransformation
"Accessor to the isoprobabilistic transformation function.
Returns
-------
transformation : :class:`~openturns.NumericalMathFunction`
The isoprobabilistic transformation function."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::setComparisonOperator
"Accessor to the comparison operator.
Parameters
----------
operator : :class:`~openturns.ComparisonOperator`
The comparison operator."
// ---------------------------------------------------------------------
%feature("docstring") OT::SimulationSensitivityAnalysis::setThreshold
"Accessor to the threshold.
Parameters
----------
s : float
The threshold."
|