simpeg.regularization.AmplitudeSmallness.amplitude#

AmplitudeSmallness.amplitude(m)[source]#

Return vector amplitudes for the model provided.

Where the model m defines a vector quantity for each active cell in the inversion, the amplitude method returns the amplitudes of these vectors.

Parameters:
m(n_param ) numpy.ndarray

The model.

Returns:
(n_cells, ) numpy.ndarray

The amplitudes of the vectors for the model provided.