Geomagnetic#

class sunpy.coordinates.frames.Geomagnetic(*args, **kwargs)[source]#

Bases: BaseMagnetic

A coordinate or frame in the Geomagnetic (MAG) system.

  • The origin is the center of the Earth.

  • The Z-axis (+90 degrees latitude) is aligned with the Earth’s magnetic north pole.

  • The X-axis (0 degrees longitude and 0 degrees latitude) is aligned with the component of the Earth’s geographic north pole that is perpendicular to the Z-axis.

Parameters:

  • data (BaseRepresentation or None) – A representation object or None to have no data (or use the coordinate component arguments, see below).

  • lon (Angle or Quantity, optional) – The longitude coordinate for this object (lat must also be given and data must be None). Not needed if data is given.

  • lat (Angle or Quantity, optional) – The latitude coordinate for this object (lon must also be given and data must be None). Not needed if data is given.

  • distance (Quantity, optional) – The distance coordinate from Earth center for this object. Not needed if data is given.

  • magnetic_model (str) – The IGRF model to use for determining the orientation of Earth’s magnetic dipole pole. The supported options are 'igrf13' (default), 'igrf12', 'igrf11', and 'igrf10'.

  • obstime (tuple, list, str, pandas.Timestamp, pandas.Series, pandas.DatetimeIndex, datetime.datetime, datetime.date, numpy.datetime64, numpy.ndarray, astropy.time.Time) – The time of the observation. This is used to determine the position of solar-system bodies (e.g., the Sun and the Earth) as needed to define the origin and orientation of the frame.

  • representation_type (BaseRepresentation, str, optional) – A representation class or string name of a representation class. This may change the valid coordinate component arguments from the defaults (see above). For example, passing representation_type='cartesian' will make the frame expect Cartesian coordinate component arguments (typically, x, y, and z).

  • copy (bool, optional) – If True (default), make copies of the input coordinate arrays.

Notes

The position of Earth’s magnetic north pole is calculated from the first three coefficients of the selected IGRF model per Franz & Harper (2002). The small offset between dipole center and Earth center is ignored.

References

Attributes Summary

default_differential

Default representation for differential data (e.g., velocity)

default_representation

Default representation for position data

frame_attributes

frame_specific_representation_info

Mapping for frame-specific component names

name

Attributes Documentation

default_differential#

Default representation for differential data (e.g., velocity)

default_representation#

Default representation for position data

frame_attributes = {'magnetic_model': <astropy.coordinates.attributes.Attribute object>, 'obstime': <sunpy.coordinates.frameattributes.TimeFrameAttributeSunPy object>}#
frame_specific_representation_info#

Mapping for frame-specific component names

name = 'geomagnetic'#