SimPEG.regularization.BaseRegularization#

Bases: SimPEG.objective_function.BaseObjectiveFunction

Base class for regularization. Inherit this for building your own regularization. The base regularization assumes a weighted l2-norm style of regularization. However, if you wish to employ a different norm, the methods __call__(), deriv() and deriv2() can be over-written

Parameters

mesh (discretize.base.BaseMesh) – SimPEG mesh
active_cells – Array of bool defining the set of active cells.
mapping – Model map
reference_model – Array of model values used to constrain the inversion
units – Model units identifier. Special case for ‘radian’
weights – Weight multipliers to customize the least-squares function.

Attributes

`W`	Weighting matrix
`active_cells`	A boolean array of active cells on the regularization
`cell_weights`	Deprecated property for 'volume' and user defined weights.
`indActive`	active_cells.indActive has been deprecated.
`mapping`	Mapping applied to the model values
`model`	Physical property model
`mref`	reference_model.mref has been deprecated.
`reference_model`	Reference physical property model
`regmesh`	regularization_mesh.regmesh has been deprecated.
`regularization_mesh`	Regularization mesh
`units`	Specify the model units.

Methods

`__call__`(m)	We use a weighted 2-norm objective function
`deriv`(m)	The regularization is:
`deriv2`(m[, v])	Second derivative
`get_weights`(key)	Weights for a given key.
`remove_weights`(key)	Removes the weights with a given key
`set_weights`(**weights)	Adds (or updates) the specified weights to the regularization

f_m
f_m_deriv

Galleries and Tutorials using `SimPEG.regularization.BaseRegularization`#

Method of Equivalent Sources for Removing VRM Responses

Cross-gradient Joint Inversion of Gravity and Magnetic Anomaly Data

SimPEG.regularization.BaseRegularization#

Galleries and Tutorials using SimPEG.regularization.BaseRegularization#

Galleries and Tutorials using `SimPEG.regularization.BaseRegularization`#