ostk.physics.environment.magnetic.Earth

class Earth(*args, **kwargs)

Bases: pybind11_object

Earth magnetic model.

Reference:

https://geographiclib.sourceforge.io/html/magnetic.html

Overloaded function.

  1. __init__(self: ostk.physics.environment.magnetic.Earth, type: ostk::physics::environment::magnetic::Earth::Type, directory: ostk.core.filesystem.Directory) -> None

    Construct an Earth magnetic model.

    Args:

    type (Earth.Type): Earth model type. directory (Directory): Directory containing the magnetic model data files.

  2. __init__(self: ostk.physics.environment.magnetic.Earth, type: ostk::physics::environment::magnetic::Earth::Type) -> None

    Construct an Earth magnetic model.

    Args:

    type (Earth.Type): Earth model type.

Methods

get_field_value_at

Get the magnetic field value at a given position and instant.

get_type

Get Earth model type.

is_defined

Check if the magnetic model is defined.

class Type(self: ostk.physics.environment.magnetic.Earth.Type, value: int)

Bases: pybind11_object

Members:

Undefined :

Undefined Earth model type.

Dipole :

Dipole Earth model type.

EMM2010 :

Enhanced Magnetic Model 2010: approximates the main and crustal magnetic fields for the period 2010–2015.

EMM2015 :

Enhanced Magnetic Model 2015: approximates the main and crustal magnetic fields for the period 2000–2020.

EMM2017 :

Enhanced Magnetic Model 2017: approximates the main and crustal magnetic fields for the period 2000–2022.

IGRF11 :

International Geomagnetic Reference Field (11th generation): approximates the main magnetic field for the period 1900–2015.

IGRF12 :

International Geomagnetic Reference Field (12th generation): approximates the main magnetic field for the period 1900–2020.

WMM2010 :

World Magnetic Model 2010: approximates the main magnetic field for the period 2010–2015.

WMM2015 :

World Magnetic Model 2015: approximates the main magnetic field for the period 2015–2020.

property name
get_field_value_at(
self: ostk.physics.environment.magnetic.Earth,
arg0: numpy.ndarray[numpy.float64[3, 1]],
arg1: ostk.physics.time.Instant,
) → numpy.ndarray[numpy.float64[3, 1]]

Get the magnetic field value at a given position and instant.

Parameters:

  • position (numpy.ndarray) -- Position, expressed in the magnetic object frame [m].

  • instant (Instant) -- Instant.

Returns:

Magnetic field value, expressed in the magnetic object frame [T].

Return type:

numpy.ndarray

get_type(
self: ostk.physics.environment.magnetic.Earth,
) → ostk::physics::environment::magnetic::Earth::Type

Get Earth model type.

Returns:

Earth model type.

Return type:

Earth.Type

is_defined(self: ostk.physics.environment.magnetic.Earth) → bool

Check if the magnetic model is defined.

Returns:

True if defined.

Return type:

bool