GeocentricSolarMagnetospheric#
- class sunpy.coordinates.frames.GeocentricSolarMagnetospheric(*args, **kwargs)[source]#
Bases:
BaseMagnetic
A coordinate or frame in the GeocentricSolarMagnetospheric (GSM) system.
The origin is the center of the Earth.
The X-axis (0 degrees longitude and 0 degrees latitude) is aligned with the Earth-Sun line.
The Z-axis (+90 degrees latitude) is aligned with the component of the Earth’s magnetic north pole that is perpendicular to the X-axis.
- Parameters:
data (
BaseRepresentation
orNone
) – A representation object orNone
to have no data (or use the coordinate component arguments, see below).lon (
Angle
orQuantity
, optional) – The longitude coordinate for this object (lat
must also be given anddata
must beNone
). Not needed ifdata
is given.lat (
Angle
orQuantity
, optional) – The latitude coordinate for this object (lon
must also be given anddata
must beNone
). Not needed ifdata
is given.distance (
Quantity
, optional) – The distance coordinate from Earth center for this object. Not needed ifdata
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, passingrepresentation_type='cartesian'
will make the frame expect Cartesian coordinate component arguments (typically,x
,y
, andz
).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 representation for differential data (e.g., velocity)
Default representation for position data
Mapping for frame-specific component names
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 = 'geocentricsolarmagnetospheric'#