pygimli.frameworks¶

Overview¶

Functions

Classes

Functions¶

computeR

pygimli.frameworks.computeR(J, C, alpha=0.5)[source]¶

Return diagional of model resolution matrix.

Calculates the formal model resolution matrix deterministically following:

\[\mathbf{R_m} = (\mathbf{J}^T\mathbf{D}^T\mathbf{D}\mathbf{J} + \alpha \mathbf{C}^T\mathbf{C})^{-1} \mathbf{J}^T\mathbf{D}^T\mathbf{D}\mathbf{J}\]

Note

The current implementation assumes that \(\mathbf{D}\) is the identitiy matrix, i.e. equal data weights.

Parameters:	J : array Jacobian matrix. C : array Constraint matrix. alpha : float Regularization strength \(\alpha\).

harmfit

pygimli.frameworks.harmfit(y, x=None, error=None, nc=42, resample=None, lam=0.1, window=None, verbose=False, dosave=False, lineSearch=True, robust=False, maxiter=20)[source]¶

HARMFIT - GIMLi based curve-fit by harmonic functions

Parameters:	y : 1d-array - values to be fitted x : 1d-array(len(y)) - data abscissa data. default: [0 .. len(y)) error : 1d-array(len(y)) error of y. default (absolute error = 0.01) nc : int - Number of harmonic coefficients resample : 1d-array - resample y to x using fitting coeffients window : int - just fit data inside window bounds
Returns:	response : 1d-array(len(resample) or len(x)) - smoothed values coefficients : 1d-array - fitting coefficients

harmfitNative

pygimli.frameworks.harmfitNative(y, x=None, nc=None, xc=None, err=None)[source]¶

python based curve-fit by harmonic functions yc = harmfitNativ(x,y[,nc,xc,err]) y .. values of a curve to be fitted x .. abscissa, if none [0..len(y)) nc .. number of coefficients xc .. abscissa to fit on (otherwise equal to x) err .. data error

Classes¶

Block1DInversion

class pygimli.frameworks.Block1DInversion(**kwargs)[source]¶

Attributes:	dataErrs debug maxIter model response verbose

Methods

run(dataVals, errVals[, nLayer])	Run inversion.
showProgress()	Called if showProgress=True is set for the inversion run.

setData
setDeltaChiStop
setError
setForwardOperator

__init__(**kwargs)[source]¶

Initialize self. See help(type(self)) for accurate signature.

dataErrs¶

debug¶

maxIter¶

model¶

response¶

run(dataVals, errVals, nLayer=4, **kwargs)[source]¶

Run inversion.

setData(data)¶

setDeltaChiStop(it)¶

setError(err)¶

setForwardOperator(fop)¶

showProgress()[source]¶

Called if showProgress=True is set for the inversion run.

verbose¶

Block1DModelling

class pygimli.frameworks.Block1DModelling(nBlocks=1, **kwargs)[source]¶

Attributes:	transModel

Methods

__call__((object)arg1, (object)model)	C++ signature : GIMLI::Vector<double> __call__(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)
clearConstraints((object)arg1)	C++ signature : void* clearConstraints(GIMLI::ModellingBase {lvalue})
clearJacobian((object)arg1)	C++ signature : void* clearJacobian(GIMLI::ModellingBase {lvalue})
constraints((object)arg1)	C++ signature : GIMLI::MatrixBase* constraints(GIMLI::ModellingBase {lvalue})
constraintsRef((object)arg1)	C++ signature : GIMLI::SparseMapMatrix<double, unsigned long> {lvalue} constraintsRef(GIMLI::ModellingBase {lvalue})
createConstraints((object)arg1)	C++ signature : void* createConstraints(GIMLI::ModellingBase {lvalue})
createDefaultStartModel((object)arg1)	C++ signature : GIMLI::Vector<double> createDefaultStartModel(GIMLI::ModellingBase {lvalue})
createJacobian((object)arg1, (object)model)	C++ signature : void* createJacobian(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)
createMappedModel((object)arg1, …)	Read only extrapolation of model values given per cell marker to values given per cell.
createRefinedForwardMesh((object)arg1 [, …)	C++ signature : void* createRefinedForwardMesh(GIMLI::ModellingBase {lvalue} [,bool=True [,bool=False]])
createStartModel(**kwargs)	Create Starting model.
createStartVector((object)arg1)	DEPRECATED use createStartModel
data((object)arg1)	Return the associated data container.
deleteMesh((object)arg1)	Delete the actual mesh.
estimateError(data, **kwargs)	Create
initConstraints((object)arg1)	C++ signature : void* initConstraints(GIMLI::ModellingBase {lvalue})
initJacobian((object)arg1)	C++ signature : void* initJacobian(GIMLI::ModellingBase {lvalue})
initRegionManager((object)arg1)	C++ signature : void* initRegionManager(GIMLI::ModellingBase {lvalue})
jacobian((object)arg1)	Return the pointer to the Jacobian matrix associated with this forward operator.
jacobianRef((object)arg1)	C++ signature : GIMLI::Matrix<double> {lvalue} jacobianRef(GIMLI::ModellingBase {lvalue})
mapModel((object)arg1, (object)model [, …)	C++ signature : void* mapModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,double=0])
mesh((object)arg1)	C++ signature : GIMLI::Mesh* mesh(GIMLI::ModellingBase {lvalue})
multiThreadJacobian((object)arg1)	Return number of threads used for Jacobian generation.
region((object)arg1, (object)marker)	Syntactic sugar for this->regionManager().region(marker).
regionManager((object)arg1)	C++ signature : GIMLI::RegionManager regionManager(GIMLI::ModellingBase {lvalue})
regionManagerRef((object)arg1)	C++ signature : GIMLI::RegionManager {lvalue} regionManagerRef(GIMLI::ModellingBase {lvalue})
response((object)arg1, (object)model)	C++ signature : GIMLI::Vector<double> response(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)
response_mt((object)arg1, (object)model [, …)	C++ signature : GIMLI::Vector<double> response_mt(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,unsigned long=0])
setConstraints((object)arg1, (object)C)	C++ signature : void* setConstraints(GIMLI::ModellingBase {lvalue},GIMLI::MatrixBase*)
setData((object)arg1, (object)data)	Change the associated data container
setDataBasis(**kwargs)	Set Data basis, e.g., DataContainer, times, coordinates.
setJacobian((object)arg1, (object)J)	C++ signature : void* setJacobian(GIMLI::ModellingBase {lvalue},GIMLI::MatrixBase*)
setMesh((object)arg1, (object)mesh [, …)	Set new mesh to the forward operator, optionally hold region parameter for the new mesh (i.e.
setMultiThreadJacobian((object)arg1, …)	Set number of threads used for brute force Jacobian generation.
setRegionManager((object)arg1, (object)reg)	C++ signature : void* setRegionManager(GIMLI::ModellingBase {lvalue},GIMLI::RegionManager*)
setStartModel((object)arg1, (object)startModel)	C++ signature : void* setStartModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)
setThreadCount((object)arg1, (object)nThreads)	Set the maximum number of allowed threads for MT calculation.
setVerbose((object)arg1, (object)verbose)	Set verbose state.
solution((object)arg1)	C++ signature : GIMLI::Matrix<double> solution(GIMLI::ModellingBase {lvalue})
startModel((object)arg1)	C++ signature : GIMLI::Vector<double> startModel(GIMLI::ModellingBase {lvalue})
threadCount((object)arg1)	Return the maximum number of allowed threads for MT calculation
verbose((object)arg1)	Get verbose state.

createJacobian_mt
responses
setForwardOperator
setLayers
setRegionProperties

__init__((object)arg1[, (object)verbose=False]) → object :[source]¶

C++ signature :

void* __init__(_object* [,bool=False])

__init__( (object)arg1, (object)dataContainer [, (object)verbose=False]) -> object :

C++ signature :

void* __init__(_object*,GIMLI::DataContainer {lvalue} [,bool=False])

__init__( (object)arg1, (object)mesh [, (object)verbose=False]) -> object :

C++ signature :

void* __init__(_object*,GIMLI::Mesh [,bool=False])

__init__( (object)arg1, (object)mesh, (object)dataContainer [, (object)verbose=False]) -> object :

C++ signature :

void* __init__(_object*,GIMLI::Mesh,GIMLI::DataContainer {lvalue} [,bool=False])

clearConstraints((object)arg1) → object :¶

C++ signature :

void* clearConstraints(GIMLI::ModellingBase {lvalue})

clearConstraints( (object)arg1) -> object :

C++ signature :

void* clearConstraints(ModellingBase_wrapper {lvalue})

clearJacobian((object)arg1) → object :¶

C++ signature :

void* clearJacobian(GIMLI::ModellingBase {lvalue})

clearJacobian( (object)arg1) -> object :

C++ signature :

void* clearJacobian(ModellingBase_wrapper {lvalue})

constraints((object)arg1) → object :¶

C++ signature :

GIMLI::MatrixBase* constraints(GIMLI::ModellingBase {lvalue})

constraints( (object)arg1) -> object :

C++ signature :

GIMLI::MatrixBase* constraints(ModellingBase_wrapper {lvalue})

constraints( (object)arg1) -> object :

C++ signature :

GIMLI::MatrixBase* constraints(GIMLI::ModellingBase {lvalue})

constraints( (object)arg1) -> object :

C++ signature :

GIMLI::MatrixBase* constraints(ModellingBase_wrapper {lvalue})

constraintsRef((object)arg1) → object :¶

C++ signature :

GIMLI::SparseMapMatrix<double, unsigned long> {lvalue} constraintsRef(GIMLI::ModellingBase {lvalue})

constraintsRef( (object)arg1) -> object :

C++ signature :

GIMLI::SparseMapMatrix<double, unsigned long> {lvalue} constraintsRef(GIMLI::ModellingBase {lvalue})

createConstraints((object)arg1) → object :¶

C++ signature :

void* createConstraints(GIMLI::ModellingBase {lvalue})

createConstraints( (object)arg1) -> object :

C++ signature :

void* createConstraints(ModellingBase_wrapper {lvalue})

createDefaultStartModel((object)arg1) → object :¶

C++ signature :

GIMLI::Vector<double> createDefaultStartModel(GIMLI::ModellingBase {lvalue})

createDefaultStartModel( (object)arg1) -> object :

C++ signature :

GIMLI::Vector<double> createDefaultStartModel(ModellingBase_wrapper {lvalue})

createJacobian((object)arg1, (object)model) → object :¶

C++ signature :

void* createJacobian(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)

createJacobian( (object)arg1, (object)model) -> object :

C++ signature :

void* createJacobian(ModellingBase_wrapper {lvalue},GIMLI::Vector<double>)

createJacobian( (object)arg1, (object)model, (object)resp) -> object :

C++ signature :

void* createJacobian(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>,GIMLI::Vector<double>)

createJacobian( (object)arg1, (object)model, (object)resp) -> object :

C++ signature :

void* createJacobian(ModellingBase_wrapper {lvalue},GIMLI::Vector<double>,GIMLI::Vector<double>)

createJacobian_mt(model, resp)¶

createMappedModel((object)arg1, (object)model[, (object)background=-1]) → object :¶

Read only extrapolation of model values given per cell marker to values given per cell. Exterior values will be set to background or prolongated for background = -1.

C++ signature :

GIMLI::Vector<double> createMappedModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,double=-1])

createRefinedForwardMesh((object)arg1[, (object)refine=True[, (object)pRefine=False]]) → object :¶

C++ signature :

void* createRefinedForwardMesh(GIMLI::ModellingBase {lvalue} [,bool=True [,bool=False]])

createStartModel(**kwargs)¶

Create Starting model.

Create Starting model based on current data values and additional args.

createStartVector((object)arg1) → object :¶

DEPRECATED use createStartModel

C++ signature :

GIMLI::Vector<double> createStartVector(GIMLI::ModellingBase {lvalue})

data((object)arg1) → object :¶

Return the associated data container.

C++ signature :

GIMLI::DataContainer {lvalue} data(GIMLI::ModellingBase {lvalue})

deleteMesh((object)arg1) → object :¶

Delete the actual mesh.

C++ signature :

void* deleteMesh(GIMLI::ModellingBase {lvalue})

estimateError(data, **kwargs)¶

Create

initConstraints((object)arg1) → object :¶

C++ signature :

void* initConstraints(GIMLI::ModellingBase {lvalue})

initConstraints( (object)arg1) -> object :

C++ signature :

void* initConstraints(ModellingBase_wrapper {lvalue})

initJacobian((object)arg1) → object :¶

C++ signature :

void* initJacobian(GIMLI::ModellingBase {lvalue})

initJacobian( (object)arg1) -> object :

C++ signature :

void* initJacobian(ModellingBase_wrapper {lvalue})

initRegionManager((object)arg1) → object :¶

C++ signature :

void* initRegionManager(GIMLI::ModellingBase {lvalue})

jacobian((object)arg1) → object :¶

Return the pointer to the Jacobian matrix associated with this forward operator.

C++ signature :

GIMLI::MatrixBase* jacobian(GIMLI::ModellingBase {lvalue})

jacobian( (object)arg1) -> object :

Return the pointer to the Jacobian matrix associated with this forward operator.

C++ signature :

GIMLI::MatrixBase* jacobian(GIMLI::ModellingBase {lvalue})

jacobianRef((object)arg1) → object :¶

C++ signature :

GIMLI::Matrix<double> {lvalue} jacobianRef(GIMLI::ModellingBase {lvalue})

jacobianRef( (object)arg1) -> object :

C++ signature :

GIMLI::Matrix<double> {lvalue} jacobianRef(GIMLI::ModellingBase {lvalue})

mapModel((object)arg1, (object)model[, (object)background=0]) → object :¶

C++ signature :

void* mapModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,double=0])

mesh((object)arg1) → object :¶

C++ signature :

GIMLI::Mesh* mesh(GIMLI::ModellingBase {lvalue})

multiThreadJacobian((object)arg1) → object :¶

Return number of threads used for Jacobian generation.

C++ signature :

unsigned long multiThreadJacobian(GIMLI::ModellingBase {lvalue})

region((object)arg1, (object)marker) → object :¶

Syntactic sugar for this->regionManager().region(marker).

C++ signature :

GIMLI::Region* region(GIMLI::ModellingBase {lvalue},int)

regionManager((object)arg1) → object :¶

C++ signature :

GIMLI::RegionManager regionManager(GIMLI::ModellingBase {lvalue})

regionManager( (object)arg1) -> object :

C++ signature :

GIMLI::RegionManager {lvalue} regionManager(GIMLI::ModellingBase {lvalue})

regionManagerRef((object)arg1) → object :¶

C++ signature :

GIMLI::RegionManager {lvalue} regionManagerRef(GIMLI::ModellingBase {lvalue})

response((object)arg1, (object)model) → object :¶

C++ signature :

GIMLI::Vector<double> response(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)

response( (object)arg1, (object)model) -> object :

C++ signature :

GIMLI::Vector<double> response(ModellingBase_wrapper {lvalue},GIMLI::Vector<double>)

response_mt((object)arg1, (object)model[, (object)i=0]) → object :¶

C++ signature :

GIMLI::Vector<double> response_mt(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,unsigned long=0])

response_mt( (object)arg1, (object)model [, (object)i=0]) -> object :

C++ signature :

GIMLI::Vector<double> response_mt(ModellingBase_wrapper {lvalue},GIMLI::Vector<double> [,unsigned long=0])

responses(models, respos)¶

setConstraints((object)arg1, (object)C) → object :¶

C++ signature :

void* setConstraints(GIMLI::ModellingBase {lvalue},GIMLI::MatrixBase*)

setConstraints( (object)arg1, (object)C) -> object :

C++ signature :

void* setConstraints(ModellingBase_wrapper {lvalue},GIMLI::MatrixBase*)

setData((object)arg1, (object)data) → object :¶

Change the associated data container

C++ signature :

void* setData(GIMLI::ModellingBase {lvalue},GIMLI::DataContainer {lvalue})

setDataBasis(**kwargs)¶

Set Data basis, e.g., DataContainer, times, coordinates.

setForwardOperator(fop)¶

setJacobian((object)arg1, (object)J) → object :¶

C++ signature :

void* setJacobian(GIMLI::ModellingBase {lvalue},GIMLI::MatrixBase*)

setJacobian( (object)arg1, (object)J) -> object :

C++ signature :

void* setJacobian(ModellingBase_wrapper {lvalue},GIMLI::MatrixBase*)

setLayers(nLayers)[source]¶

setMesh((object)arg1, (object)mesh [, (object)ignoreRegionManager=False]) -> object : Set new mesh to the forward operator, optionally hold region parameter for the new mesh (i.e. for roll a long)¶

Set new mesh to the forward operator, optionally hold region parameter for the new mesh (i.e. for roll a long)

C++ signature :

void* setMesh(GIMLI::ModellingBase {lvalue},GIMLI::Mesh [,bool=False])

setMultiThreadJacobian((object)arg1, (object)nThreads) → object :¶

Set number of threads used for brute force Jacobian generation. 1 is default. If nThreads is greater than 1 you need to implement response_mt with a read only response function. Maybe its worth set the single setThreadCount to 1 than, that you dont find yourself in a threading overkill.

C++ signature :

void* setMultiThreadJacobian(GIMLI::ModellingBase {lvalue},unsigned long)

setRegionManager((object)arg1, (object)reg) → object :¶

C++ signature :

void* setRegionManager(GIMLI::ModellingBase {lvalue},GIMLI::RegionManager*)

setRegionProperties(region, startModel=None, limits=None, trans=None)¶

setStartModel((object)arg1, (object)startModel) → object :¶

C++ signature :

void* setStartModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)

setStartModel( (object)arg1, (object)startModel) -> object :

C++ signature :

void* setStartModel(ModellingBase_wrapper {lvalue},GIMLI::Vector<double>)

setThreadCount((object)arg1, (object)nThreads) → object :¶

Set the maximum number of allowed threads for MT calculation. Have to be greater than 0. Will also set ENV(OPENBLAS_NUM_THREADS) .. if used.

C++ signature :

void* setThreadCount(GIMLI::ModellingBase {lvalue},unsigned long)

setVerbose((object)arg1, (object)verbose) → object :¶

Set verbose state.

C++ signature :

void* setVerbose(GIMLI::ModellingBase {lvalue},bool)

solution((object)arg1) → object :¶

C++ signature :

GIMLI::Matrix<double> solution(GIMLI::ModellingBase {lvalue})

startModel((object)arg1) → object :¶

C++ signature :

GIMLI::Vector<double> startModel(GIMLI::ModellingBase {lvalue})

startModel( (object)arg1) -> object :

C++ signature :

GIMLI::Vector<double> startModel(ModellingBase_wrapper {lvalue})

threadCount((object)arg1) → object :¶

Return the maximum number of allowed threads for MT calculation

C++ signature :

unsigned long threadCount(GIMLI::ModellingBase {lvalue})

transModel¶

verbose((object)arg1) → object :¶

Get verbose state.

C++ signature :

bool verbose(GIMLI::ModellingBase {lvalue})

verbose( (object)arg1) -> object :

C++ signature :

bool verbose(GIMLI::ModellingBase {lvalue})

HarmFunctor

class pygimli.frameworks.HarmFunctor(A, coeff, xmin, xSpan)[source]¶

Methods

__call__(x)

Call self as a function.

__init__(A, coeff, xmin, xSpan)[source]¶

Initialize self. See help(type(self)) for accurate signature.

Inversion

class pygimli.frameworks.Inversion(**kwargs)[source]¶

Basic inversion framework. Attributes ———- verbose : bool

Give verbose output

debug : bool

Give debug output

Attributes:	dataErrs debug maxIter model response verbose

Methods

run(dataVals, errorVals, **kwargs)	Run inversion.
showProgress()	Called if showProgress=True is set for the inversion run.

setData
setDeltaChiStop
setError
setForwardOperator

__init__(**kwargs)[source]¶

Initialize self. See help(type(self)) for accurate signature.

dataErrs¶

debug¶

maxIter¶

model¶

response¶

run(dataVals, errorVals, **kwargs)[source]¶

Run inversion.

setData(data)[source]¶

setDeltaChiStop(it)[source]¶

setError(err)[source]¶

setForwardOperator(fop)[source]¶

showProgress()[source]¶

Called if showProgress=True is set for the inversion run.

verbose¶

MarquardtInversion

class pygimli.frameworks.MarquardtInversion(**kwargs)[source]¶

Marquardt scheme (local damping with decreasing regularization strength

Attributes:	dataErrs debug maxIter model response verbose

Methods

run(data, error, **kwargs)	Run inversion.
showProgress()	Called if showProgress=True is set for the inversion run.

setData
setDeltaChiStop
setError
setForwardOperator

__init__(**kwargs)[source]¶

Initialize self. See help(type(self)) for accurate signature.

dataErrs¶

debug¶

maxIter¶

model¶

response¶

run(data, error, **kwargs)[source]¶

Run inversion.

setData(data)¶

setDeltaChiStop(it)¶

setError(err)¶

setForwardOperator(fop)¶

showProgress()¶

Called if showProgress=True is set for the inversion run.

verbose¶

MeshInversion

class pygimli.frameworks.MeshInversion(**kwargs)[source]¶

Attributes:	dataErrs debug maxIter model response verbose

Methods

run(dataVals, errorVals, **kwargs)	Run inversion.
showProgress()	Called if showProgress=True is set for the inversion run.

invert
setData
setDeltaChiStop
setError
setForwardOperator
setMesh

__init__(**kwargs)[source]¶

Initialize self. See help(type(self)) for accurate signature.

dataErrs¶

debug¶

invert(data=None, mesh=None, lam=20, **kwargs)[source]¶

maxIter¶

model¶

response¶

run(dataVals, errorVals, **kwargs)¶

Run inversion.

setData(data)¶

setDeltaChiStop(it)¶

setError(err)¶

setForwardOperator(fop)¶

setMesh(mesh)[source]¶

showProgress()¶

Called if showProgress=True is set for the inversion run.

verbose¶

Modelling

class pygimli.frameworks.Modelling(**kwargs)[source]¶

Abstract Forward Operator.

Abstract Forward Operator that use one or more different ModellingBase classes. Can be seen as some kind of proxy Forward Operator.

Attributes:	transModel

Methods

__call__((object)arg1, (object)model)	C++ signature : GIMLI::Vector<double> __call__(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)
clearConstraints((object)arg1)	C++ signature : void* clearConstraints(GIMLI::ModellingBase {lvalue})
clearJacobian((object)arg1)	C++ signature : void* clearJacobian(GIMLI::ModellingBase {lvalue})
constraints((object)arg1)	C++ signature : GIMLI::MatrixBase* constraints(GIMLI::ModellingBase {lvalue})
constraintsRef((object)arg1)	C++ signature : GIMLI::SparseMapMatrix<double, unsigned long> {lvalue} constraintsRef(GIMLI::ModellingBase {lvalue})
createConstraints((object)arg1)	C++ signature : void* createConstraints(GIMLI::ModellingBase {lvalue})
createDefaultStartModel((object)arg1)	C++ signature : GIMLI::Vector<double> createDefaultStartModel(GIMLI::ModellingBase {lvalue})
createJacobian((object)arg1, (object)model)	C++ signature : void* createJacobian(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)
createMappedModel((object)arg1, …)	Read only extrapolation of model values given per cell marker to values given per cell.
createRefinedForwardMesh((object)arg1 [, …)	C++ signature : void* createRefinedForwardMesh(GIMLI::ModellingBase {lvalue} [,bool=True [,bool=False]])
createStartModel(**kwargs)	Create Starting model.
createStartVector((object)arg1)	DEPRECATED use createStartModel
data((object)arg1)	Return the associated data container.
deleteMesh((object)arg1)	Delete the actual mesh.
estimateError(data, **kwargs)	Create
initConstraints((object)arg1)	C++ signature : void* initConstraints(GIMLI::ModellingBase {lvalue})
initJacobian((object)arg1)	C++ signature : void* initJacobian(GIMLI::ModellingBase {lvalue})
initRegionManager((object)arg1)	C++ signature : void* initRegionManager(GIMLI::ModellingBase {lvalue})
jacobian((object)arg1)	Return the pointer to the Jacobian matrix associated with this forward operator.
jacobianRef((object)arg1)	C++ signature : GIMLI::Matrix<double> {lvalue} jacobianRef(GIMLI::ModellingBase {lvalue})
mapModel((object)arg1, (object)model [, …)	C++ signature : void* mapModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,double=0])
mesh((object)arg1)	C++ signature : GIMLI::Mesh* mesh(GIMLI::ModellingBase {lvalue})
multiThreadJacobian((object)arg1)	Return number of threads used for Jacobian generation.
region((object)arg1, (object)marker)	Syntactic sugar for this->regionManager().region(marker).
regionManager((object)arg1)	C++ signature : GIMLI::RegionManager regionManager(GIMLI::ModellingBase {lvalue})
regionManagerRef((object)arg1)	C++ signature : GIMLI::RegionManager {lvalue} regionManagerRef(GIMLI::ModellingBase {lvalue})
response((object)arg1, (object)model)	C++ signature : GIMLI::Vector<double> response(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)
response_mt((object)arg1, (object)model [, …)	C++ signature : GIMLI::Vector<double> response_mt(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,unsigned long=0])
setConstraints((object)arg1, (object)C)	C++ signature : void* setConstraints(GIMLI::ModellingBase {lvalue},GIMLI::MatrixBase*)
setData((object)arg1, (object)data)	Change the associated data container
setDataBasis(**kwargs)	Set Data basis, e.g., DataContainer, times, coordinates.
setJacobian((object)arg1, (object)J)	C++ signature : void* setJacobian(GIMLI::ModellingBase {lvalue},GIMLI::MatrixBase*)
setMesh((object)arg1, (object)mesh [, …)	Set new mesh to the forward operator, optionally hold region parameter for the new mesh (i.e.
setMultiThreadJacobian((object)arg1, …)	Set number of threads used for brute force Jacobian generation.
setRegionManager((object)arg1, (object)reg)	C++ signature : void* setRegionManager(GIMLI::ModellingBase {lvalue},GIMLI::RegionManager*)
setStartModel((object)arg1, (object)startModel)	C++ signature : void* setStartModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)
setThreadCount((object)arg1, (object)nThreads)	Set the maximum number of allowed threads for MT calculation.
setVerbose((object)arg1, (object)verbose)	Set verbose state.
solution((object)arg1)	C++ signature : GIMLI::Matrix<double> solution(GIMLI::ModellingBase {lvalue})
startModel((object)arg1)	C++ signature : GIMLI::Vector<double> startModel(GIMLI::ModellingBase {lvalue})
threadCount((object)arg1)	Return the maximum number of allowed threads for MT calculation
verbose((object)arg1)	Get verbose state.

createJacobian_mt
responses
setForwardOperator
setRegionProperties

__init__((object)arg1[, (object)verbose=False]) → object :[source]¶

C++ signature :

void* __init__(_object* [,bool=False])

__init__( (object)arg1, (object)dataContainer [, (object)verbose=False]) -> object :

C++ signature :

void* __init__(_object*,GIMLI::DataContainer {lvalue} [,bool=False])

__init__( (object)arg1, (object)mesh [, (object)verbose=False]) -> object :

C++ signature :

void* __init__(_object*,GIMLI::Mesh [,bool=False])

__init__( (object)arg1, (object)mesh, (object)dataContainer [, (object)verbose=False]) -> object :

C++ signature :

void* __init__(_object*,GIMLI::Mesh,GIMLI::DataContainer {lvalue} [,bool=False])

clearConstraints((object)arg1) → object :¶

C++ signature :

void* clearConstraints(GIMLI::ModellingBase {lvalue})

clearConstraints( (object)arg1) -> object :

C++ signature :

void* clearConstraints(ModellingBase_wrapper {lvalue})

clearJacobian((object)arg1) → object :¶

C++ signature :

void* clearJacobian(GIMLI::ModellingBase {lvalue})

clearJacobian( (object)arg1) -> object :

C++ signature :

void* clearJacobian(ModellingBase_wrapper {lvalue})

constraints((object)arg1) → object :¶

C++ signature :

GIMLI::MatrixBase* constraints(GIMLI::ModellingBase {lvalue})

constraints( (object)arg1) -> object :

C++ signature :

GIMLI::MatrixBase* constraints(ModellingBase_wrapper {lvalue})

constraints( (object)arg1) -> object :

C++ signature :

GIMLI::MatrixBase* constraints(GIMLI::ModellingBase {lvalue})

constraints( (object)arg1) -> object :

C++ signature :

GIMLI::MatrixBase* constraints(ModellingBase_wrapper {lvalue})

constraintsRef((object)arg1) → object :¶

C++ signature :

GIMLI::SparseMapMatrix<double, unsigned long> {lvalue} constraintsRef(GIMLI::ModellingBase {lvalue})

constraintsRef( (object)arg1) -> object :

C++ signature :

GIMLI::SparseMapMatrix<double, unsigned long> {lvalue} constraintsRef(GIMLI::ModellingBase {lvalue})

createConstraints((object)arg1) → object :¶

C++ signature :

void* createConstraints(GIMLI::ModellingBase {lvalue})

createConstraints( (object)arg1) -> object :

C++ signature :

void* createConstraints(ModellingBase_wrapper {lvalue})

createDefaultStartModel((object)arg1) → object :¶

C++ signature :

GIMLI::Vector<double> createDefaultStartModel(GIMLI::ModellingBase {lvalue})

createDefaultStartModel( (object)arg1) -> object :

C++ signature :

GIMLI::Vector<double> createDefaultStartModel(ModellingBase_wrapper {lvalue})

createJacobian((object)arg1, (object)model) → object :¶

C++ signature :

void* createJacobian(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)

createJacobian( (object)arg1, (object)model) -> object :

C++ signature :

void* createJacobian(ModellingBase_wrapper {lvalue},GIMLI::Vector<double>)

createJacobian( (object)arg1, (object)model, (object)resp) -> object :

C++ signature :

void* createJacobian(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>,GIMLI::Vector<double>)

createJacobian( (object)arg1, (object)model, (object)resp) -> object :

C++ signature :

void* createJacobian(ModellingBase_wrapper {lvalue},GIMLI::Vector<double>,GIMLI::Vector<double>)

createJacobian_mt(model, resp)¶

createMappedModel((object)arg1, (object)model[, (object)background=-1]) → object :¶

Read only extrapolation of model values given per cell marker to values given per cell. Exterior values will be set to background or prolongated for background = -1.

C++ signature :

GIMLI::Vector<double> createMappedModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,double=-1])

createRefinedForwardMesh((object)arg1[, (object)refine=True[, (object)pRefine=False]]) → object :¶

C++ signature :

void* createRefinedForwardMesh(GIMLI::ModellingBase {lvalue} [,bool=True [,bool=False]])

createStartModel(**kwargs)[source]¶

Create Starting model.

Create Starting model based on current data values and additional args.

createStartVector((object)arg1) → object :¶

DEPRECATED use createStartModel

C++ signature :

GIMLI::Vector<double> createStartVector(GIMLI::ModellingBase {lvalue})

data((object)arg1) → object :¶

Return the associated data container.

C++ signature :

GIMLI::DataContainer {lvalue} data(GIMLI::ModellingBase {lvalue})

deleteMesh((object)arg1) → object :¶

Delete the actual mesh.

C++ signature :

void* deleteMesh(GIMLI::ModellingBase {lvalue})

estimateError(data, **kwargs)[source]¶

Create

initConstraints((object)arg1) → object :¶

C++ signature :

void* initConstraints(GIMLI::ModellingBase {lvalue})

initConstraints( (object)arg1) -> object :

C++ signature :

void* initConstraints(ModellingBase_wrapper {lvalue})

initJacobian((object)arg1) → object :¶

C++ signature :

void* initJacobian(GIMLI::ModellingBase {lvalue})

initJacobian( (object)arg1) -> object :

C++ signature :

void* initJacobian(ModellingBase_wrapper {lvalue})

initRegionManager((object)arg1) → object :¶

C++ signature :

void* initRegionManager(GIMLI::ModellingBase {lvalue})

jacobian((object)arg1) → object :¶

Return the pointer to the Jacobian matrix associated with this forward operator.

C++ signature :

GIMLI::MatrixBase* jacobian(GIMLI::ModellingBase {lvalue})

jacobian( (object)arg1) -> object :

Return the pointer to the Jacobian matrix associated with this forward operator.

C++ signature :

GIMLI::MatrixBase* jacobian(GIMLI::ModellingBase {lvalue})

jacobianRef((object)arg1) → object :¶

C++ signature :

GIMLI::Matrix<double> {lvalue} jacobianRef(GIMLI::ModellingBase {lvalue})

jacobianRef( (object)arg1) -> object :

C++ signature :

GIMLI::Matrix<double> {lvalue} jacobianRef(GIMLI::ModellingBase {lvalue})

mapModel((object)arg1, (object)model[, (object)background=0]) → object :¶

C++ signature :

void* mapModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,double=0])

mesh((object)arg1) → object :¶

C++ signature :

GIMLI::Mesh* mesh(GIMLI::ModellingBase {lvalue})

multiThreadJacobian((object)arg1) → object :¶

Return number of threads used for Jacobian generation.

C++ signature :

unsigned long multiThreadJacobian(GIMLI::ModellingBase {lvalue})

region((object)arg1, (object)marker) → object :¶

Syntactic sugar for this->regionManager().region(marker).

C++ signature :

GIMLI::Region* region(GIMLI::ModellingBase {lvalue},int)

regionManager((object)arg1) → object :¶

C++ signature :

GIMLI::RegionManager regionManager(GIMLI::ModellingBase {lvalue})

regionManager( (object)arg1) -> object :

C++ signature :

GIMLI::RegionManager {lvalue} regionManager(GIMLI::ModellingBase {lvalue})

regionManagerRef((object)arg1) → object :¶

C++ signature :

GIMLI::RegionManager {lvalue} regionManagerRef(GIMLI::ModellingBase {lvalue})

response((object)arg1, (object)model) → object :¶

C++ signature :

GIMLI::Vector<double> response(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)

response( (object)arg1, (object)model) -> object :

C++ signature :

GIMLI::Vector<double> response(ModellingBase_wrapper {lvalue},GIMLI::Vector<double>)

response_mt((object)arg1, (object)model[, (object)i=0]) → object :¶

C++ signature :

GIMLI::Vector<double> response_mt(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double> [,unsigned long=0])

response_mt( (object)arg1, (object)model [, (object)i=0]) -> object :

C++ signature :

GIMLI::Vector<double> response_mt(ModellingBase_wrapper {lvalue},GIMLI::Vector<double> [,unsigned long=0])

responses(models, respos)¶

setConstraints((object)arg1, (object)C) → object :¶

C++ signature :

void* setConstraints(GIMLI::ModellingBase {lvalue},GIMLI::MatrixBase*)

setConstraints( (object)arg1, (object)C) -> object :

C++ signature :

void* setConstraints(ModellingBase_wrapper {lvalue},GIMLI::MatrixBase*)

setData((object)arg1, (object)data) → object :[source]¶

Change the associated data container

C++ signature :

void* setData(GIMLI::ModellingBase {lvalue},GIMLI::DataContainer {lvalue})

setDataBasis(**kwargs)[source]¶

Set Data basis, e.g., DataContainer, times, coordinates.

setForwardOperator(fop)[source]¶

setJacobian((object)arg1, (object)J) → object :¶

C++ signature :

void* setJacobian(GIMLI::ModellingBase {lvalue},GIMLI::MatrixBase*)

setJacobian( (object)arg1, (object)J) -> object :

C++ signature :

void* setJacobian(ModellingBase_wrapper {lvalue},GIMLI::MatrixBase*)

setMesh((object)arg1, (object)mesh [, (object)ignoreRegionManager=False]) -> object : Set new mesh to the forward operator, optionally hold region parameter for the new mesh (i.e. for roll a long)[source]¶

Set new mesh to the forward operator, optionally hold region parameter for the new mesh (i.e. for roll a long)

C++ signature :

void* setMesh(GIMLI::ModellingBase {lvalue},GIMLI::Mesh [,bool=False])

setMultiThreadJacobian((object)arg1, (object)nThreads) → object :¶

Set number of threads used for brute force Jacobian generation. 1 is default. If nThreads is greater than 1 you need to implement response_mt with a read only response function. Maybe its worth set the single setThreadCount to 1 than, that you dont find yourself in a threading overkill.

C++ signature :

void* setMultiThreadJacobian(GIMLI::ModellingBase {lvalue},unsigned long)

setRegionManager((object)arg1, (object)reg) → object :¶

C++ signature :

void* setRegionManager(GIMLI::ModellingBase {lvalue},GIMLI::RegionManager*)

setRegionProperties(region, startModel=None, limits=None, trans=None)[source]¶

setStartModel((object)arg1, (object)startModel) → object :¶

C++ signature :

void* setStartModel(GIMLI::ModellingBase {lvalue},GIMLI::Vector<double>)

setStartModel( (object)arg1, (object)startModel) -> object :

C++ signature :

void* setStartModel(ModellingBase_wrapper {lvalue},GIMLI::Vector<double>)

setThreadCount((object)arg1, (object)nThreads) → object :¶

Set the maximum number of allowed threads for MT calculation. Have to be greater than 0. Will also set ENV(OPENBLAS_NUM_THREADS) .. if used.

C++ signature :

void* setThreadCount(GIMLI::ModellingBase {lvalue},unsigned long)

setVerbose((object)arg1, (object)verbose) → object :¶

Set verbose state.

C++ signature :

void* setVerbose(GIMLI::ModellingBase {lvalue},bool)

solution((object)arg1) → object :¶

C++ signature :

GIMLI::Matrix<double> solution(GIMLI::ModellingBase {lvalue})

startModel((object)arg1) → object :¶

C++ signature :

GIMLI::Vector<double> startModel(GIMLI::ModellingBase {lvalue})

startModel( (object)arg1) -> object :

C++ signature :

GIMLI::Vector<double> startModel(ModellingBase_wrapper {lvalue})

threadCount((object)arg1) → object :¶

Return the maximum number of allowed threads for MT calculation

C++ signature :

unsigned long threadCount(GIMLI::ModellingBase {lvalue})

transModel¶

verbose((object)arg1) → object :¶

Get verbose state.

C++ signature :

bool verbose(GIMLI::ModellingBase {lvalue})

verbose( (object)arg1) -> object :

C++ signature :

bool verbose(GIMLI::ModellingBase {lvalue})