PythonFieldFunction¶
-
class
PythonFieldFunction
(*args)¶ Override FieldFunction from Python.
Parameters: Examples
>>> import openturns as ot >>> def myPyFunc(X): ... mesh = X.getMesh() ... values = X.getValues() * ([2.0]*X.getValues().getDimension()) ... values.setDescription(ot.Description.BuildDefault(values.getDimension(), 'Y')) ... Y = ot.Field(mesh, values) ... return Y >>> inputDim = 2 >>> outputDim = 2 >>> spatialDim = 1 >>> myFunc = ot.PythonFieldFunction(inputDim, outputDim, spatialDim, myPyFunc)
Methods
getCallsNumber
()Get the number of calls of the function. getClassName
()Accessor to the object’s name. getId
()Accessor to the object’s id. getImplementation
(*args)Accessor to the underlying implementation. getInputDescription
()Get the description of the input field values. getInputDimension
()Get the dimension of the input field values. getMarginal
(*args)Get the marginal(s) at given indice(s). getName
()Accessor to the object’s name. getOutputDescription
()Get the description of the output field values. getOutputDimension
()Get the dimension of the output field values. getOutputMesh
(inputMesh)Get the mesh associated to the output domain. getSpatialDimension
()Get the dimension of the input domain. setName
(name)Accessor to the object’s name. __call__ -
__init__
(*args)¶ Initialize self. See help(type(self)) for accurate signature.
-
getCallsNumber
()¶ Get the number of calls of the function.
Returns: - callsNumber : int
Counts the number of times the function has been called since its creation.
-
getClassName
()¶ Accessor to the object’s name.
Returns: - class_name : str
The object class name (object.__class__.__name__).
-
getId
()¶ Accessor to the object’s id.
Returns: - id : int
Internal unique identifier.
-
getImplementation
(*args)¶ Accessor to the underlying implementation.
Returns: - impl : Implementation
The implementation class.
-
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: - d : int
Dimension
of the input field values.
-
getMarginal
(*args)¶ Get the marginal(s) at given indice(s).
Parameters: - i : int or list of ints,
Indice(s) of the marginal(s) to be extracted.
Returns: - fieldFunction :
FieldFunction
The initial function restricted to the concerned marginal(s) at the indice(s)
.
- i : int or list of ints,
-
getName
()¶ Accessor to the object’s name.
Returns: - name : str
The name of the object.
-
getOutputDescription
()¶ Get the description of the output field values.
Returns: - outputDescription :
Description
Description of the output field values.
- outputDescription :
-
getOutputDimension
()¶ Get the dimension of the output field values.
Returns: - d’ : int
Dimension
of the output field values.
-
getOutputMesh
(inputMesh)¶ Get the mesh associated to the output domain.
Returns: - outputMesh :
Mesh
The output mesh
.
- outputMesh :
-
getSpatialDimension
()¶ Get the dimension of the input domain.
Returns: - spatialDim : int,
Dimension
of the input domain
.
-
setName
(name)¶ Accessor to the object’s name.
Parameters: - name : str
The name of the object.
-