ARMAState¶

class ARMAState(*args)

Last state recorded of an ARMA process.

Parameters: values : Sample Last values of the process of dimension . noises : Sample Last values of the white noise defining the process of dimension .

Examples

Define a state of an process of dimension 1:

>>> import openturns as ot
>>> myLastValues = ot.Sample([[0.6], [0.7], [0.3], [0.2]])
>>> myLastNoiseValues = ot.Sample([[1.2], [1.8]])
>>> myARMAState = ot.ARMAState(myLastValues, myLastNoiseValues)


Methods

 getClassName() Accessor to the object’s name. getDimension() Accessor to the dimension of coefficients in the list. getEpsilon() Accessor to the last values of the noise defining the ARMA process. getId() Accessor to the object’s id. getName() Accessor to the object’s name. getShadowedId() Accessor to the object’s shadowed id. getVisibility() Accessor to the object’s visibility state. getX() Accessor to the last values of the ARMA process. hasName() Test if the object is named. hasVisibleName() Test if the object has a distinguishable name. setName(name) Accessor to the object’s name. setShadowedId(id) Accessor to the object’s shadowed id. setVisibility(visible) Accessor to the object’s visibility state. setXEpsilon(x, epsilon) Accessor to the last values of the noise defining the ARMA process.
__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

getClassName()

Accessor to the object’s name.

Returns: class_name : str The object class name (object.__class__.__name__).
getDimension()

Accessor to the dimension of coefficients in the list.

Returns: dimension : int The dimension of the ARMA process.
getEpsilon()

Accessor to the last values of the noise defining the ARMA process.

Returns: noises : Sample of size and dimension Last values of the white noise of the process of dimension .
getId()

Accessor to the object’s id.

Returns: id : int Internal unique identifier.
getName()

Accessor to the object’s name.

Returns: name : str The name of the object.
getShadowedId()

Accessor to the object’s shadowed id.

Returns: id : int Internal unique identifier.
getVisibility()

Accessor to the object’s visibility state.

Returns: visible : bool Visibility flag.
getX()

Accessor to the last values of the ARMA process.

Returns: values : Sample of size and dimension Last values of the process of dimension .
hasName()

Test if the object is named.

Returns: hasName : bool True if the name is not empty.
hasVisibleName()

Test if the object has a distinguishable name.

Returns: hasVisibleName : bool True if the name is not empty and not the default one.
setName(name)

Accessor to the object’s name.

Parameters: name : str The name of the object.
setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters: id : int Internal unique identifier.
setVisibility(visible)

Accessor to the object’s visibility state.

Parameters: visible : bool Visibility flag.
setXEpsilon(x, epsilon)

Accessor to the last values of the noise defining the ARMA process.

Parameters: values : Sample of size and dimension Last values of the process of dimension . noises : Sample of size and dimension Last values of the white noise of the process of dimension .