simpeg.regularization.BaseRegularization#
- class simpeg.regularization.BaseRegularization(mesh, active_cells=None, mapping=None, reference_model=None, units=None, weights=None, **kwargs)[source]#
Bases:
BaseObjectiveFunction
Base regularization class.
The
BaseRegularization
class defines properties and methods inherited by SimPEG regularization classes, and is not directly used to construct inversions.- Parameters:
- mesh
simpeg.regularization.RegularizationMesh
,discretize.base.BaseMesh
Mesh on which the regularization is discretized. This is not necessarily the same as the mesh on which the simulation is defined.
- active_cells
None
, (n_cells
, )numpy.ndarray
of
bool Boolean array defining the set of
RegularizationMesh
cells that are active in the inversion. IfNone
, all cells are active.- mapping
None
,simpeg.maps.BaseMap
The mapping from the model parameters to the active cells in the inversion. If
None
, the mapping is set tosimpeg.maps.IdentityMap
.- reference_model
None
, (n_param
, )numpy.ndarray
Reference model. If
None
, the reference model in the inversion is set to the starting model.- units
None
,str
Units for the model parameters. Some regularization classes behave differently depending on the units; e.g. ‘radian’.
- weights
None
,dict
Weight multipliers to customize the least-squares function. Each value is a numpy.ndarray of shape(:py:property:`~.regularization.RegularizationMesh.n_cells`, ).
- mesh
Attributes
Weighting matrix.
Active cells defined on the regularization mesh.
Mapping from the inversion model parameters to the regularization mesh.
The model parameters.
Number of model parameters.
The parent objective function
Reference model.
Regularization mesh.
Units for the model parameters.
Return the keys for the existing cell weights
Methods
__call__
(m)Evaluate the regularization function for the model provided.
deriv
(m)Gradient of the regularization function evaluated for the model provided.
deriv2
(m[, v])Hessian of the regularization function evaluated for the model provided.
f_m
(m)Not implemented for
BaseRegularization
class.f_m_deriv
(m)Not implemented for
BaseRegularization
class.get_weights
(key)Cell weights for a given key.
map_class
alias of
IdentityMap
remove_weights
(key)Removes the weights for the key provided.
set_weights
(**weights)Adds (or updates) the specified weights to the regularization.
test
([x, num, random_seed])Run a convergence test on both the first and second derivatives.
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