- 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)#
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
deriv2()can be over-written
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.
A boolean array of active cells on the regularization
Deprecated property for 'volume' and user defined weights.
active_cells.indActive has been deprecated.
Mapping applied to the model values
Physical property model
reference_model.mref has been deprecated.
Reference physical property model
regularization_mesh.regmesh has been deprecated.
Specify the model units.
We use a weighted 2-norm objective function
The regularization is:
Weights for a given key.
Removes the weights with a given key
Adds (or updates) the specified weights to the regularization