PythonFieldToPointFunction

class PythonFieldToPointFunction(inputMesh, inputDim, outputDim, func=None)

Override FieldToPointFunction from Python.

Parameters
inputMeshMesh

The input mesh

inputDimpositive int

Dimension of the input field values d

outputDimpositive int

Dimension of the output vector d’

funca callable python object

called on a Field object. Returns a Field. Default is None.

Examples

>>> import openturns as ot
>>> mesh = ot.Mesh(1)
>>> def myPyFunc(X):
...     Y = ot.Sample(X).computeMean()
...     return Y
>>> inputDim = 2
>>> outputDim = 2
>>> myFunc = ot.PythonFieldToPointFunction(mesh, inputDim, outputDim, myPyFunc)

Methods

__call__(*args)

Call self as a function.

getCallsNumber()

Get the number of calls of the function.

getClassName()

Accessor to the object's name.

getId()

Accessor to the object's id.

getImplementation()

Accessor to the underlying implementation.

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.

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__).

getId()

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getImplementation()

Accessor to the underlying implementation.

Returns
implImplementation

A copy of the underlying implementation object.

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.

Returns
functionFieldToPointFunction

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.

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.