- 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 regularization class.
BaseRegularizationclass defines properties and methods inherited by SimPEG regularization classes, and is not directly used to construct inversions.
Mesh on which the regularization is discretized. This is not necessarily the same as the mesh on which the simulation is defined.
Boolean array defining the set of
RegularizationMeshcells that are active in the inversion. If
None, all cells are active.
The mapping from the model parameters to the active cells in the inversion. If
None, the mapping is set to
Reference model. If
None, the reference model in the inversion is set to the starting model.
Units for the model parameters. Some regularization classes behave differently depending on the units; e.g. ‘radian’.
Weight multipliers to customize the least-squares function. Each value is a numpy.ndarray of shape(:py:property:`~.regularization.RegularizationMesh.n_cells`, ).
Active cells defined on the regularization mesh.
Deprecated property for 'volume' and user defined weights.
active_cells.indActive has been deprecated.
Mapping from the inversion model parameters to the regularization mesh.
The model parameters.
reference_model.mref has been deprecated.
The parent objective function
regularization_mesh.regmesh has been deprecated.
Units for the model parameters.
Evaluate the regularization function for the model provided.
Gradient of the regularization function evaluated for the model provided.
Hessian of the regularization function evaluated for the model provided.
Not implemented for
Not implemented for
Cell weights for a given key.
Removes the weights for the key provided.
Adds (or updates) the specified weights to the regularization.