simpeg.regularization.BaseSimilarityMeasure#

class simpeg.regularization.BaseSimilarityMeasure(mesh, wire_map, **kwargs)[source]#

Bases: BaseRegularization

Base regularization class for joint inversion.

The BaseSimilarityMeasure class defines properties and methods used by regularization classes for joint inversion. It is not directly used to constrain inversions.

Parameters:
meshsimpeg.regularization.RegularizationMesh

Mesh on which the regularization is discretized. This is not necessarily the same as the mesh on which the simulation is defined.

wire_mapsimpeg.maps.WireMap

Wire map connecting physical properties defined on active cells of the RegularizationMesh to the entire model.

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.

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

wire_map

Mapping from model to physical properties defined on the regularization mesh.

Methods

__call__(model)

Not implemented for BaseSimilarityMeasure class.

deriv(model)

Not implemented for BaseSimilarityMeasure class.

deriv2(model[, v])

Not implemented for BaseSimilarityMeasure class.

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, random_seed])

Run a convergence test on both the first and second derivatives.

Galleries and Tutorials using simpeg.regularization.BaseSimilarityMeasure#

Cross-gradient Joint Inversion of Gravity and Magnetic Anomaly Data

Cross-gradient Joint Inversion of Gravity and Magnetic Anomaly Data