Reference/API for supporting coordinates modules

The parts of the following modules that are useful to a typical user are already imported into the sunpy.coordinates namespace.

sunpy.coordinates.frames Module

Common solar physics coordinate systems.

This submodule implements various solar physics coordinate frames for use with the astropy.coordinates module.

Classes

SunPyBaseCoordinateFrame(*args, **kwargs)

Base class for sunpy coordinate frames.

BaseHeliographic(*args, **kwargs)

Base class for HeliographicCarrington (HGC) and HeliographicStonyhurst (HGS) frames.

HeliographicStonyhurst(*args, **kwargs)

A coordinate or frame in the Stonyhurst Heliographic (HGS) system.

HeliographicCarrington(*args, **kwargs)

A coordinate or frame in the Carrington Heliographic (HGC) system.

Heliocentric(*args, **kwargs)

A coordinate or frame in the Heliocentric system, which is observer-based.

Helioprojective(*args, **kwargs)

A coordinate or frame in the Helioprojective Cartesian (HPC) system, which is observer-based.

HeliocentricEarthEcliptic(*args, **kwargs)

A coordinate or frame in the Heliocentric Earth Ecliptic (HEE) system.

GeocentricSolarEcliptic(*args, **kwargs)

A coordinate or frame in the Geocentric Solar Ecliptic (GSE) system.

HeliocentricInertial(*args, **kwargs)

A coordinate or frame in the Heliocentric Inertial (HCI) system.

GeocentricEarthEquatorial(*args, **kwargs)

A coordinate or frame in the Geocentric Earth Equatorial (GEI) system.

Class Inheritance Diagram

Inheritance diagram of sunpy.coordinates.frames.SunPyBaseCoordinateFrame, sunpy.coordinates.frames.BaseHeliographic, sunpy.coordinates.frames.HeliographicStonyhurst, sunpy.coordinates.frames.HeliographicCarrington, sunpy.coordinates.frames.Heliocentric, sunpy.coordinates.frames.Helioprojective, sunpy.coordinates.frames.HeliocentricEarthEcliptic, sunpy.coordinates.frames.GeocentricSolarEcliptic, sunpy.coordinates.frames.HeliocentricInertial, sunpy.coordinates.frames.GeocentricEarthEquatorial

sunpy.coordinates.metaframes Module

Coordinate frames that are defined relative to other frames

Classes

NorthOffsetFrame(*args, **kwargs)

A frame which is offset from another frame such that it shares the same origin, but has its “north pole” (i.e., the Z axis) in a different direction.

RotatedSunFrame(*args, **kwargs)

A frame that applies solar rotation to a base coordinate frame.

Class Inheritance Diagram

Inheritance diagram of sunpy.coordinates.metaframes.NorthOffsetFrame, sunpy.coordinates.metaframes.RotatedSunFrame

sunpy.coordinates.transformations Module

Coordinate Transformation Functions

This module contains the functions for converting one sunpy.coordinates.frames object to another.

Warning

The functions in this submodule should never be called directly, transforming between coordinate frames should be done using the .transform_to methods on BaseCoordinateFrame or SkyCoord instances.

Functions

transform_with_sun_center()

Context manager for coordinate transformations to ignore the motion of the center of the Sun.

hgs_to_hgc(hgscoord, hgcframe)

Convert from Heliographic Stonyhurst to Heliographic Carrington.

hgc_to_hgs(hgccoord, hgsframe)

Convert from Heliographic Carrington to Heliographic Stonyhurst.

hcc_to_hpc(helioccoord, heliopframe)

Convert from Heliocentric Cartesian to Helioprojective Cartesian.

hpc_to_hcc(heliopcoord, heliocframe)

Convert from Helioprojective Cartesian to Heliocentric Cartesian.

hcc_to_hgs(helioccoord, heliogframe)

Convert from Heliocentric Cartesian to Heliographic Stonyhurst.

hgs_to_hcc(heliogcoord, heliocframe)

Convert from Heliographic Stonyhurst to Heliocentric Cartesian.

hpc_to_hpc(from_coo, to_frame)

This converts from HPC to HPC, with different observer location parameters.

hcrs_to_hgs(hcrscoord, hgsframe)

Convert from HCRS to Heliographic Stonyhurst (HGS).

hgs_to_hcrs(hgscoord, hcrsframe)

Convert from Heliographic Stonyhurst to HCRS.

hgs_to_hgs(from_coo, to_frame)

Convert between two Heliographic Stonyhurst frames.

hgc_to_hgc(from_coo, to_frame)

Convert between two Heliographic Carrington frames.

hcc_to_hcc(from_coo, to_frame)

Convert between two Heliocentric frames.

hme_to_hee(hmecoord, heeframe)

Convert from Heliocentric Mean Ecliptic to Heliocentric Earth Ecliptic

hee_to_hme(heecoord, hmeframe)

Convert from Heliocentric Earth Ecliptic to Heliocentric Mean Ecliptic

hee_to_hee(from_coo, to_frame)

Convert between two Heliocentric Earth Ecliptic frames.

hee_to_gse(heecoord, gseframe)

Convert from Heliocentric Earth Ecliptic to Geocentric Solar Ecliptic

gse_to_hee(gsecoord, heeframe)

Convert from Geocentric Solar Ecliptic to Heliocentric Earth Ecliptic

gse_to_gse(from_coo, to_frame)

Convert between two Geocentric Solar Ecliptic frames.

hgs_to_hci(hgscoord, hciframe)

Convert from Heliographic Stonyhurst to Heliocentric Inertial

hci_to_hgs(hcicoord, hgsframe)

Convert from Heliocentric Inertial to Heliographic Stonyhurst

hci_to_hci(from_coo, to_frame)

Convert between two Heliocentric Inertial frames.

hme_to_gei(hmecoord, geiframe)

Convert from Heliocentric Mean Ecliptic to Geocentric Earth Equatorial

gei_to_hme(geicoord, hmeframe)

Convert from Geocentric Earth Equatorial to Heliocentric Mean Ecliptic

gei_to_gei(from_coo, to_frame)

Convert between two Geocentric Earth Equatorial frames.

sunpy.coordinates.wcs_utils Module

Functions

solar_wcs_frame_mapping(wcs)

This function registers the coordinates frames to their FITS-WCS coordinate type values in the astropy.wcs.utils.wcs_to_celestial_frame registry.

solar_frame_to_wcs_mapping(frame[, projection])

For a given frame, this function returns the corresponding WCS object.