KarhunenLoeveProjection

class KarhunenLoeveProjection(*args)

Function dedicated to the projection of fields on a Karhunen-Loeve basis.

Parameters:
KLResultKarhunenLoeveResult

The result structure created by a KarhunenLoeveAlgorithm

Notes

The class KarhunenLoeveProjection is a specific function FieldToPointFunction 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 or ProcessSample associated to a Mesh with an input dimension equal to n.

Methods

getCallsNumber()

Get the number of calls of the function.

getClassName()

Accessor to the object's name.

getInputDescription()

Get the description of the input field values.

getInputDimension()

Get the dimension of the input field values.

getInputMesh()

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.

getOutputDescription()

Get the description of the output vector.

getOutputDimension()

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:
inputDescriptionDescription

Description of the input field values.

getInputDimension()

Get the dimension of the input field values.

Returns:
dint

Dimension d of the input field values.

getInputMesh()

Get the mesh associated to the input domain.

Returns:
inputMeshMesh

The input mesh \cM_{N'}.

getMarginal(*args)

Get the marginal(s) at given indice(s).

Parameters:
iint or list of ints, 0 \leq i < d

Indice(s) of the marginal(s) to be extracted. output vector.

Returns:
functionKarhunenLoeveProjection

The initial function restricted to the concerned marginal(s) at the indice(s) i.

getName()

Accessor to the object’s name.

Returns:
namestr

The name of the object.

getOutputDescription()

Get the description of the output vector.

Returns:
outputDescriptionDescription

Description of the output vector.

getOutputDimension()

Get the dimension of the output vector.

Returns:
d’int

Dimension d' 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.

Examples using the class

Metamodel of a field function

Metamodel of a field function