simpeg.directives.SphericalUnitsWeights#

class simpeg.directives.SphericalUnitsWeights(amplitude, angles, verbose=True, **kwargs)[source]#

Bases: InversionDirective

Directive to update the regularization weights to account for spherical parameters in radian and SI.

The scaling applied to the regularization weights is based on the ratio between the maximum value of the model and the maximum value of angles (pi).

Parameters:
amplitude: Projection

Map to the model parameters for the amplitude of the vector

angles: list[WeightedLeastSquares]

List of WeightedLeastSquares for the angles.

verbose: bool

Print information to the screen.

Attributes

debug

verbose.debug has been deprecated.

dmisfit

Data misfit associated with the directive.

invProb

Inverse problem associated with the directive.

inversion

Inversion object associated with the directive.

opt

Optimization algorithm associated with the directive.

reg

Regularization associated with the directive.

simulation

Return simulation for all data misfits.

survey

Return survey for all data misfits

verbose

Whether or not to print debugging information.

Methods

endIter()

Update inversion parameter(s) according to directive at end of iteration.

finish()

Update inversion parameter(s) according to directive at end of inversion.

initialize()

Initialize inversion parameter(s) according to directive.

update_scaling()

Add an 'angle_scale' to the list of weights on the angle regularization for the different block of models to account for units of radian and SI.

validate([directiveList])

Validate directive.