SimPEG.potential_fields.magnetics.UniformBackgroundField#

class SimPEG.potential_fields.magnetics.UniformBackgroundField(receiver_list=None, amplitude=50000.0, inclination=90.0, declination=0.0, **kwargs)[source]#

Bases: BaseSrc

A constant uniform background magnetic field.

This inducing field has a uniform magnetic background field defined by an amplitude, inclination, and declination.

Parameters:

receiver_listlist of SimPEG.potential_fields.magnetics.Point
parameterstuple of (amplitude, inclutation, declination), optional: Deprecated input for the function, provided in this position for backwards compatibility
amplitudefloat, optional: amplitude of the inducing backgound field, usually this is in units of nT.
inclinationfloat, optional: Dip angle in degrees from the horizon, positive points into the earth.
declinationfloat, optional: Azimuthal angle in degrees from north, positive clockwise.

Attributes

`amplitude`	Amplitude of the inducing background field.
`declination`	Azimuthal angle from north.
`inclination`	Dip angle in from the horizon.
`location`	Source location
`nD`	Number of data associated with the source.
`receiver_list`	List of receivers associated with the source
`uid`	Universal unique identifier
`vnD`	Vector number of data.