simpeg.directives.InversionDirective#

class simpeg.directives.InversionDirective(inversion=None, dmisfit=None, reg=None, verbose=False, **kwargs)[source]#

Bases: object

Base inversion directive class.

SimPEG directives initialize and update parameters used by the inversion algorithm; e.g. setting the initial beta or updating the regularization. InversionDirective is a parent class responsible for connecting directives to the data misfit, regularization and optimization defining the inverse problem.

Parameters:

inversionsimpeg.inversion.BaseInversion, None: An SimPEG inversion object; i.e. an instance of simpeg.inversion.BaseInversion.
dmisfitsimpeg.data_misfit.BaseDataMisfit, None: A data data misfit; i.e. an instance of simpeg.data_misfit.BaseDataMisfit.
regsimpeg.regularization.BaseRegularization, None: The regularization, or model objective function; i.e. an instance of simpeg.regularization.BaseRegularization.
verbosebool: Whether or not to print debugging information.

Attributes

`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.
`validate`([directiveList])	Validate directive.