/usr/include/openturns/swig/FunctionalBasisProcess_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 | %feature("docstring") OT::FunctionalBasisProcess
"Functional basis process.
Parameters
----------
distribution : :class:`~openturns.Distribution`
The distribution of the random vector :math:`\\\\vect{A}=(A_1,\\\\dots, A_K)`.
basis : :class:`~openturns.Basis`
Collection of deterministic functions.
mesh : :class:`~openturns.Mesh`
Mesh :math:`\\\\cM` over which the domain :math:`\\\\cD` is discretized.
Notes
-----
A functional basis process :math:`X: \\\\Omega \\\\times\\\\cD \\\\mapsto \\\\Rset^d` where :math:`\\\\cD \\\\in \\\\Rset^n`, writes:
.. math::
X(\\\\omega,\\\\vect{t})=\\\\sum_{i=1}^K A_i(\\\\omega)\\\\phi_i(\\\\vect{t}) \\\\quad \\\\forall \\\\omega \\\\in \\\\Omega and \\\\forall \\\\vect{t} \\\\in \\\\cD
with :math:`\\\\phi_i: \\\\Rset^n \\\\rightarrow \\\\Rset^d` for :math:`1 \\\\leq i \\\\leq K` and :math:`\\\\vect{A}=(A_1,\\\\dots, A_K)` a random vector of dimension :math:`K`.
Examples
--------
Create the coefficients distribution:
>>> import openturns as ot
>>> coefDist = ot.Normal([2]*2, [5]*2, ot.CorrelationMatrix(2))
Create a basis of functions:
>>> phi_1 = ot.NumericalMathFunction(['t'], ['sin(t)'])
>>> phi_2 = ot.NumericalMathFunction(['t'], ['cos(t)*cos(t)'])
>>> myBasis = ot.Basis([phi_1, phi_2])
Create a mesh:
>>> myMesh = ot.RegularGrid(0.0, 0.1,300)
Create the functional basis process:
>>> myFBProcess = ot.FunctionalBasisProcess(coefDist, myBasis, myMesh)"
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalBasisProcess::getBasis
"Get the basis of deterministic functions.
Returns
-------
basis : :class:`~openturns.Basis`
Collection of functions :math:`(\\\\phi_i)_{1 \\\\leq i \\\\leq K}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalBasisProcess::getDistribution
"Get the coefficients distribution.
Returns
-------
distribution : :class:`~openturns.Distribution`
The distribution of the random vector :math:`\\\\vect{A}=(A_1,\\\\dots, A_K)` of dimension :math:`K`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalBasisProcess::setBasis
"Set the basis of deterministic functions.
Parameters
----------
basis : :class:`~openturns.Basis`
Collection of functions :math:`(\\\\phi_i)_{1 \\\\leq i \\\\leq K}`."
// ---------------------------------------------------------------------
%feature("docstring") OT::FunctionalBasisProcess::setDistribution
"Set the coefficients distribution.
Parameters
----------
distribution : :class:`~openturns.Distribution`
The distribution of the random vector :math:`\\\\vect{A}=(A_1,\\\\dots, A_K)` of dimension :math:`K`."
|