SimPEG.regularization.BaseRegularization

class SimPEG.regularization.BaseRegularization(mesh: RegularizationMesh | BaseMesh, active_cells: np.ndarray | None = None, mapping: maps.IdentityMap | None = None, reference_model: np.ndarray | None = None, units: str | None = None, weights: dict | None = None, **kwargs)

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:

meshSimPEG.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_cellsNone, (n_cells, ) numpy.ndarray of bool

Boolean array defining the set of RegularizationMesh cells that are active in the inversion. If None, all cells are active.

mappingNone, SimPEG.maps.BaseMap

The mapping from the model parameters to the active cells in the inversion. If None, the mapping is set to SimPEG.maps.IdentityMap.

reference_modelNone, (n_param, ) numpy.ndarray

Reference model. If None, the reference model in the inversion is set to the starting model.

unitsNone, str

Units for the model parameters. Some regularization classes behave differently depending on the units; e.g. ‘radian’.

weightsNone, dict

Weight multipliers to customize the least-squares function. Each value is a numpy.ndarray of shape(:py:property:`~.regularization.RegularizationMesh.n_cells`, ).

Attributes

W	Weighting matrix.
active_cells	Active cells defined on the regularization mesh.
cell_weights	Deprecated property for 'volume' and user defined weights.
indActive	active_cells.indActive has been deprecated.
mapping	Mapping from the inversion model parameters to the regularization mesh.
model	The model parameters.
mref	reference_model.mref has been deprecated.
nP	Number of model parameters.
parent	The parent objective function
reference_model	Reference model.
regmesh	regularization_mesh.regmesh has been deprecated.
regularization_mesh	Regularization mesh.
units	Units for the model parameters.
weights_keys	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])	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

Method of Equivalent Sources for Removing VRM Responses

Cross-gradient Joint Inversion of Gravity and Magnetic Anomaly Data

Cross-gradient Joint Inversion of Gravity and Magnetic Anomaly Data