BaseMagnetic#

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

Bases: SunPyBaseCoordinateFrame

Base class for frames that rely on the Earth’s magnetic model (MAG, SM, and GSM).

This class is not intended to be used directly and has no transformations defined.

Attributes Summary

default_differential

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

default_representation

Default representation for position data

dipole_lonlat

The geographic longitude/latitude of the Earth's magnetic north pole.

dipole_moment

The Earth's dipole moment.

frame_attributes

frame_specific_representation_info

Mapping for frame-specific component names

magnetic_model

A frame attribute

name

Attributes Documentation

default_differential#

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

default_representation#

Default representation for position data

dipole_lonlat#

The geographic longitude/latitude of the Earth’s magnetic north pole.

This position 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

dipole_moment#

The Earth’s dipole moment.

The moment is calculated from the first three coefficients of the selected IGRF model per Franz & Harper (2002).

References

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

magnetic_model#

A frame attribute

Default: igrf13

name = 'basemagnetic'#