KarhunenLoeveProjection¶
- class KarhunenLoeveProjection(*args)¶
Function dedicated to the projection of fields on a Karhunen-Loeve basis.
- Parameters:
- KLResult
KarhunenLoeveResult
The result structure created by a
KarhunenLoeveAlgorithm
- KLResult
Notes
The class
KarhunenLoeveProjection
is a specific functionFieldToPointFunction
dedicated to the projection of fields on a Karhunen-Loeve basis.See the documentation of
KarhunenLoeveResult
to get information on the projection function.The function acts on
Field
orProcessSample
associated to aMesh
with an input dimension equal to .Methods
Get the number of calls of the function.
Accessor to the object's name.
Get the description of the input field values.
Get the dimension of the input field values.
Get the mesh associated to the input domain.
getMarginal
(*args)Get the marginal(s) at given indice(s).
getName
()Accessor to the object's name.
Get the description of the output vector.
Get the dimension of the output vector.
hasName
()Test if the object is named.
setInputDescription
(inputDescription)Set the description of the input field values.
setName
(name)Accessor to the object's name.
setOutputDescription
(outputDescription)Set the description of the output vector.
- __init__(*args)¶
- getCallsNumber()¶
Get the number of calls of the function.
- Returns:
- callsNumberint
Counts the number of times the function has been called since its creation.
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getInputDescription()¶
Get the description of the input field values.
- Returns:
- inputDescription
Description
Description of the input field values.
- inputDescription
- getInputDimension()¶
Get the dimension of the input field values.
- Returns:
- dint
Dimension of the input field values.
- getMarginal(*args)¶
Get the marginal(s) at given indice(s).
- Parameters:
- iint or list of ints,
Indice(s) of the marginal(s) to be extracted. output vector.
- Returns:
- function
KarhunenLoeveProjection
The initial function restricted to the concerned marginal(s) at the indice(s) .
- function
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- getOutputDescription()¶
Get the description of the output vector.
- Returns:
- outputDescription
Description
Description of the output vector.
- outputDescription
- getOutputDimension()¶
Get the dimension of the output vector.
- Returns:
- d’int
Dimension of the output vector.
- hasName()¶
Test if the object is named.
- Returns:
- hasNamebool
True if the name is not empty.
- setInputDescription(inputDescription)¶
Set the description of the input field values.
- Parameters:
- inputDescriptionsequence of str
Description of the input field values.
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.
- setOutputDescription(outputDescription)¶
Set the description of the output vector.
- Parameters:
- outputDescriptionsequence of str
Description of the output vector.