UnionEvent¶

class UnionEvent(*args)

Event defined as the union of several events.

An occurence of one single event yields the occurence of the system event (series system):

Parameters
collsequence of RandomVector

Collection of events

Event

Examples

>>> import openturns as ot
>>> dim = 2
>>> X = ot.RandomVector(ot.Normal(dim))
>>> f1 = ot.SymbolicFunction(['x1', 'x2'], ['x1'])
>>> f2 = ot.SymbolicFunction(['x1', 'x2'], ['x2'])
>>> Y1 = ot.CompositeRandomVector(f1, X)
>>> Y2 = ot.CompositeRandomVector(f2, X)
>>> e1 = ot.ThresholdEvent(Y1, ot.Less(), 0.0)
>>> e2 = ot.ThresholdEvent(Y2, ot.Greater(), 0.0)
>>> event = ot.UnionEvent([e1, e2])


Then it can be used for sampling (or with simulation algorithms):

>>> p = event.getSample(1000).computeMean()


Methods

 Accessor to the antecedent random vector. Accessor to the object's name. Accessor to the composed event. Accessor to the covariance of the RandomVector. Accessor to the description of the RandomVector. Accessor to the dimension of the RandomVector. Accessor to the distribution of the RandomVector. Get the domain. Accessor to sub events. Accessor to the function. Accessor to the object's id. getMarginal(*args) Get the random vector corresponding to the marginal component(s). Accessor to the mean of the RandomVector. Accessor to the object's name. Accessor to the comparaison operator of the Event. Accessor to the parameter of the distribution. Accessor to the parameter description of the distribution. Get the stochastic process. Compute one realization of the RandomVector. getSample(size) Compute realizations of the RandomVector. Accessor to the object's shadowed id. Accessor to the threshold of the Event. Accessor to the object's visibility state. Test if the object is named. Test if the object has a distinguishable name. Accessor to know if the RandomVector is a composite one. Whether the random vector is an event. setDescription(description) Accessor to the description of the RandomVector. setEventCollection(collection) Accessor to sub events. setName(name) Accessor to the object's name. setParameter(parameters) Accessor to the parameter of the distribution. Accessor to the object's shadowed id. setVisibility(visible) Accessor to the object's visibility state.
__init__(*args)
getAntecedent()

Accessor to the antecedent random vector.

Returns
antecedentRandomVector

Defined as the root cause.

getClassName()

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getComposedEvent()

Accessor to the composed event.

Returns
composedRandomVector

Composed event.

getCovariance()

Accessor to the covariance of the RandomVector.

Returns
covarianceCovarianceMatrix

Covariance of the considered UsualRandomVector.

Examples

>>> import openturns as ot
>>> distribution = ot.Normal([0.0, 0.5], [1.0, 1.5], ot.CorrelationMatrix(2))
>>> randomVector = ot.RandomVector(distribution)
>>> ot.RandomGenerator.SetSeed(0)
>>> print(randomVector.getCovariance())
[[ 1    0    ]
[ 0    2.25 ]]

getDescription()

Accessor to the description of the RandomVector.

Returns
descriptionDescription

Describes the components of the RandomVector.

getDimension()

Accessor to the dimension of the RandomVector.

Returns
dimensionpositive int

Dimension of the RandomVector.

getDistribution()

Accessor to the distribution of the RandomVector.

Returns
distributionDistribution

Distribution of the considered UsualRandomVector.

Examples

>>> import openturns as ot
>>> distribution = ot.Normal([0.0, 0.0], [1.0, 1.0], ot.CorrelationMatrix(2))
>>> randomVector = ot.RandomVector(distribution)
>>> ot.RandomGenerator.SetSeed(0)
>>> print(randomVector.getDistribution())
Normal(mu = [0,0], sigma = [1,1], R = [[ 1 0 ]
[ 0 1 ]])

getDomain()

Get the domain.

Returns
domainDomain

Composed domain.

getEventCollection()

Accessor to sub events.

Returns
eventsRandomVectorCollection

List of sub events.

getFunction()

Accessor to the function.

Returns
functionFunction

Composed function.

getId()

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getMarginal(*args)

Get the random vector corresponding to the marginal component(s).

Parameters
iint or list of ints,

Indicates the component(s) concerned. is the dimension of the RandomVector.

Returns
vectorRandomVector

RandomVector restricted to the concerned components.

Notes

Let’s note a random vector and a set of indices. If is a UsualRandomVector, the subvector is defined by . If is a CompositeRandomVector, defined by with , some scalar functions, the subvector is .

Examples

>>> import openturns as ot
>>> distribution = ot.Normal([0.0, 0.0], [1.0, 1.0], ot.CorrelationMatrix(2))
>>> randomVector = ot.RandomVector(distribution)
>>> ot.RandomGenerator.SetSeed(0)
>>> print(randomVector.getMarginal(1).getRealization())
[0.608202]
>>> print(randomVector.getMarginal(1).getDistribution())
Normal(mu = 0, sigma = 1)

getMean()

Accessor to the mean of the RandomVector.

Returns
meanPoint

Mean of the considered UsualRandomVector.

Examples

>>> import openturns as ot
>>> distribution = ot.Normal([0.0, 0.5], [1.0, 1.5], ot.CorrelationMatrix(2))
>>> randomVector = ot.RandomVector(distribution)
>>> ot.RandomGenerator.SetSeed(0)
>>> print(randomVector.getMean())
[0,0.5]

getName()

Accessor to the object’s name.

Returns
namestr

The name of the object.

getOperator()

Accessor to the comparaison operator of the Event.

Returns
operatorComparisonOperator

Comparaison operator used to define the RandomVector.

getParameter()

Accessor to the parameter of the distribution.

Returns
parameterPoint

Parameter values.

getParameterDescription()

Accessor to the parameter description of the distribution.

Returns
descriptionDescription

Parameter names.

getProcess()

Get the stochastic process.

Returns
processProcess

Stochastic process used to define the RandomVector.

getRealization()

Compute one realization of the RandomVector.

Returns
aRealizationPoint

Sequence of values randomly determined from the RandomVector definition. In the case of an event: one realization of the event (considered as a Bernoulli variable) which is a boolean value (1 for the realization of the event and 0 else).

Examples

>>> import openturns as ot
>>> distribution = ot.Normal([0.0, 0.0], [1.0, 1.0], ot.CorrelationMatrix(2))
>>> randomVector = ot.RandomVector(distribution)
>>> ot.RandomGenerator.SetSeed(0)
>>> print(randomVector.getRealization())
[0.608202,-1.26617]
>>> print(randomVector.getRealization())
[-0.438266,1.20548]

getSample(size)

Compute realizations of the RandomVector.

Parameters
nint,

Number of realizations needed.

Returns
realizationsSample

n sequences of values randomly determined from the RandomVector definition. In the case of an event: n realizations of the event (considered as a Bernoulli variable) which are boolean values (1 for the realization of the event and 0 else).

Examples

>>> import openturns as ot
>>> distribution = ot.Normal([0.0, 0.0], [1.0, 1.0], ot.CorrelationMatrix(2))
>>> randomVector = ot.RandomVector(distribution)
>>> ot.RandomGenerator.SetSeed(0)
>>> print(randomVector.getSample(3))
[ X0        X1        ]
0 : [  0.608202 -1.26617  ]
1 : [ -0.438266  1.20548  ]
2 : [ -2.18139   0.350042 ]


Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getThreshold()

Accessor to the threshold of the Event.

Returns
thresholdfloat

Threshold of the RandomVector.

getVisibility()

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName()

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

True if the name is not empty and not the default one.

isComposite()

Accessor to know if the RandomVector is a composite one.

Returns
isCompositebool

Indicates if the RandomVector is of type Composite or not.

isEvent()

Whether the random vector is an event.

Returns
isEventbool

Whether it takes it values in {0, 1}.

setDescription(description)

Accessor to the description of the RandomVector.

Parameters
descriptionstr or sequence of str

Describes the components of the RandomVector.

setEventCollection(collection)

Accessor to sub events.

Parameters
eventssequence of RandomVector

List of sub events.

setName(name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setParameter(parameters)

Accessor to the parameter of the distribution.

Parameters
parametersequence of float

Parameter values.

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.