SimPEG.regularization.BaseAmplitude#

class SimPEG.regularization.BaseAmplitude(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)[source]#

Bases: BaseVectorRegularization

Base amplitude regularization class for models defined by vector quantities.

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

Methods

amplitude(m)

Return vector amplitudes 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.