spinifex.magnetic.models

Module for getting the Earth magnetic field

Attributes

magnetic_models

Classes

MagneticFieldFunction

Magnetic field callable

MagneticModels

Supported magnetic field models

MagneticProfile

Data object to hold Magnetic field profile and uncertainties

Functions

get_ppigrf_magnetic_field(→ MagneticProfile)

Get the magnetic field at a given EarthLocation

parse_magnetic_model(→ MagneticFieldFunction)

parse magnetic model name

Module Contents

class spinifex.magnetic.models.MagneticFieldFunction[source]

Bases: Protocol

Magnetic field callable

__call__(ipp: spinifex.geometry.get_ipp.IPP) → MagneticProfile[source]
class spinifex.magnetic.models.MagneticModels[source]

Supported magnetic field models

ppigrf: MagneticFieldFunction[source]
class spinifex.magnetic.models.MagneticProfile[source]

Bases: NamedTuple

Data object to hold Magnetic field profile and uncertainties

magnetic_field: astropy.units.Quantity[source]
magnetic_field_error: astropy.units.Quantity[source]
spinifex.magnetic.models.get_ppigrf_magnetic_field(ipp: spinifex.geometry.get_ipp.IPP) → MagneticProfile[source]

Get the magnetic field at a given EarthLocation

spinifex.magnetic.models.parse_magnetic_model(magnetic_model_name: str) → MagneticFieldFunction[source]

parse magnetic model name

Parameters

magnetic_model_namestr

name of the magnetic model

Returns

MagneticFieldFunction

magnetic field function

Raises

TypeError

if the magnetic model is not known

spinifex.magnetic.models.magnetic_models[source]