simpeg.regularization.CrossGradient.calculate_cross_gradient#

CrossGradient.calculate_cross_gradient(model, normalized=False, rtol=1e-06)[source]#

Calculates the magnitudes of the cross-gradient vectors at cell centers.

Computes and returns a discrete approximation to:

$$|\mathrm{\nabla }{m}_1\times \mathrm{\nabla }{m}_2|$$

at all cell centers where $m_1$ and $m_2$ define the continuous spacial distribution of physical properties 1 and 2.

Parameters:

modelnumpy.ndarray

The input model, which will be automatically separated into the two parameters internally.

normalizedbool, optional

Whether to normalize the cross-gradients.

rtolfloat, optional

relative cuttoff for small gradients in the normalization.

Returns:

numpy.ndarray

Magnitudes of the cross-gradient vectors at cell centers.