SimPEG.regularization.BaseVectorRegularization

class SimPEG.regularization.BaseVectorRegularization(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: BaseRegularization

Base regularization class for models defined by vector quantities.

The BaseVectorRegularization class defines properties and methods used by regularization classes for inversion to recover vector quantities. It is not directly used to constrain inversions.

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.
n_comp	Number of components in the model.
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.