SimulationSensitivityAnalysis¶

class
SimulationSensitivityAnalysis
(*args)¶ 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, outputSample2d sequence of float
Input sample and output sample of a model evaluated apart.
 transformation
Function
An isoprobabilistic transformation function.
 comparisonOp
ComparisonOperator
A comparison operator.
 thresholdfloat
A threshold.
 event
Event
An event which it composite (test is with the method
isComposite
). simulationRes
ProbabilitySimulationResult
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
simulation
that produced simulationRes.
Methods
computeImportanceFactors
(self, \*args)Compute the importance factors.
computeMeanPointInEventDomain
(self, \*args)Accessor to the mean point.
drawImportanceFactors
(self)Draw the importance factors.
drawImportanceFactorsRange
(self, \*args)Draw the importance factors evolution.
getClassName
(self)Accessor to the object’s name.
getComparisonOperator
(self)Accessor to the comparison operator.
getId
(self)Accessor to the object’s id.
getInputSample
(self)Accessor to the input sample.
getName
(self)Accessor to the object’s name.
getOutputSample
(self)Accessor to the output sample.
getShadowedId
(self)Accessor to the object’s shadowed id.
getThreshold
(self)Accessor to the threshold.
getTransformation
(self)Accessor to the isoprobabilistic transformation function.
getVisibility
(self)Accessor to the object’s visibility state.
hasName
(self)Test if the object is named.
hasVisibleName
(self)Test if the object has a distinguishable name.
setComparisonOperator
(self, comparisonOperator)Accessor to the comparison operator.
setName
(self, name)Accessor to the object’s name.
setShadowedId
(self, id)Accessor to the object’s shadowed id.
setThreshold
(self, threshold)Accessor to the threshold.
setVisibility
(self, visible)Accessor to the object’s visibility state.

__init__
(self, *args)¶ Initialize self. See help(type(self)) for accurate signature.

computeImportanceFactors
(self, *args)¶ Compute the importance factors.
 Returns
 impFactors
Point
The importance factors.
 impFactors
Notes
The importance factors, given in (2), are evaluated from the coordinates of the mean point (1) of the event domain, mapped into the standard space as follows:
(1)¶
(2)¶
where
Be careful: this notion is only valid for
MonteCarlo
orLHS
sampling as the mean is evaluated from the equation (2) (only uniform weights over the realizations .

computeMeanPointInEventDomain
(self, *args)¶ Accessor to the mean point.
 Returns
 mean
Point
The mean point in the failure domain.
 mean
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 (1) (only uniform weights over the realizations .

drawImportanceFactors
(self)¶ Draw the importance factors.
 Returns
 graph
Graph
Graph containing the pie corresponding to the importance factors of the probabilistic variables.
 graph

drawImportanceFactorsRange
(self, *args)¶ Draw the importance factors evolution.
 Parameters
 probabilityScaleboolean
Set True if the limits are the probability levels; set False if the limits are the thresholds defining the event.
 lower, upperfloats
Define the boundaries of the probability levels and or those of the thresholds and .
 Returns

getClassName
(self)¶ Accessor to the object’s name.
 Returns
 class_namestr
The object class name (object.__class__.__name__).

getComparisonOperator
(self)¶ Accessor to the comparison operator.
 Returns
 operator
ComparisonOperator
The comparison operator.
 operator

getId
(self)¶ Accessor to the object’s id.
 Returns
 idint
Internal unique identifier.

getName
(self)¶ Accessor to the object’s name.
 Returns
 namestr
The name of the object.

getShadowedId
(self)¶ Accessor to the object’s shadowed id.
 Returns
 idint
Internal unique identifier.

getThreshold
(self)¶ Accessor to the threshold.
 Returns
 sfloat
The threshold.

getTransformation
(self)¶ Accessor to the isoprobabilistic transformation function.
 Returns
 transformation
Function
The isoprobabilistic transformation function.
 transformation

getVisibility
(self)¶ Accessor to the object’s visibility state.
 Returns
 visiblebool
Visibility flag.

hasName
(self)¶ Test if the object is named.
 Returns
 hasNamebool
True if the name is not empty.

hasVisibleName
(self)¶ Test if the object has a distinguishable name.
 Returns
 hasVisibleNamebool
True if the name is not empty and not the default one.

setComparisonOperator
(self, comparisonOperator)¶ Accessor to the comparison operator.
 Parameters
 operator
ComparisonOperator
The comparison operator.
 operator

setName
(self, name)¶ Accessor to the object’s name.
 Parameters
 namestr
The name of the object.

setShadowedId
(self, id)¶ Accessor to the object’s shadowed id.
 Parameters
 idint
Internal unique identifier.

setThreshold
(self, threshold)¶ Accessor to the threshold.
 Parameters
 sfloat
The threshold.

setVisibility
(self, visible)¶ Accessor to the object’s visibility state.
 Parameters
 visiblebool
Visibility flag.