simpeg.regularization.CrossGradient.__call__#

CrossGradient.__call__(model)[source]#

Evaluate the cross-gradient regularization function for the model provided.

See the Notes section of the documentation for the CrossGradient class for a full description of the regularization function.

Parameters:
m(n_param, ) numpy.ndarray

The model; a vector array containing all physical properties.

Returns:
float

The regularization function evaluated for the model provided.