SimPEG.regularization.LinearCorrespondence#
- class SimPEG.regularization.LinearCorrespondence(mesh, wire_map, coefficients=None, **kwargs)[source]#
Bases:
BaseSimilarityMeasure
Linear correspondence regularization for joint inversion with two physical properties.
LinearCorrespondence
is used to recover a model where the differences between the model parameter values for two physical property types are minimal.LinearCorrespondence
can also be used to minimize the squared L2-norm of a linear combination of model parameters for two physical property types. See the Notes section for a comprehensive description.- Parameters:
- mesh
SimPEG.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_cells
None
, (n_cells
, )numpy.ndarray
of
bool Boolean array defining the set of
RegularizationMesh
cells that are active in the inversion. IfNone
, all cells are active.- wire_map
SimPEG.maps.Wires
Wire map connecting physical properties defined on active cells of the
RegularizationMesh`
to the entire model.- coefficients
None
, (3)numpy.ndarray
of
float
Coefficients
for the linear relationship between model parameters. IfNone
, the coefficients are set to .
- mesh
Notes
Let
be a discrete model consisting of two physical property types such that:Where
define scalar coefficients for a linear combination of vectors and , the regularization function (objective function) is given by:Scalar coefficients
are set using the coefficients property. For a true linear correspondence constraint, we set to .Attributes
Coefficients for the linear relationship between model parameters.
Methods
__call__
(model)Evaluate the regularization function for the model provided.
deriv
(model)Gradient of the regularization function evaluated for the model provided.
deriv2
(model[, v])Hessian of the regularization function evaluated for the model provided.
relation
(model)Computes the relation vector for the model provided.