Heliocentric

class sunpy.coordinates.frames.Heliocentric(*args, **kwargs)[source] [edit on github]

Bases: astropy.coordinates.BaseCoordinateFrame

A coordinate or frame in the Heliocentric system. This frame may either be specified in Cartesian or cylindrical representation. Cylindrical representation replaces (x, y) with (rho, psi) where rho is the impact parameter and psi is the position angle in degrees.

Parameters:
  • representation (BaseRepresentation or None.) – A representation object. If specified, other parameters must be in keyword form and if x, y and z are specified, it must be None.
  • x (Quantity object.) – X-axis coordinate, optional, must be keyword.
  • y (Quantity object.) – Y-axis coordinate, optional, must be keyword.
  • z (Quantity object. Shared by both representations.) – Z-axis coordinate, optional, must be keyword.
  • observer (HeliographicStonyhurst) – The coordinate of the observer in the solar system.
  • obstime (SunPy Time) – The date and time of the observation, used to convert to heliographic carrington coordinates.

Examples

>>> from astropy.coordinates import SkyCoord, CartesianRepresentation
>>> import sunpy.coordinates
>>> import astropy.units as u
>>> sc = SkyCoord(CartesianRepresentation(10*u.km, 1*u.km, 2*u.km),
...               obstime="2011/01/05T00:00:50", frame="heliocentric")
>>> sc
<SkyCoord (HelioCentric): obstime=2011-01-05 00:00:50, D0=149597870.7 km,
x=10.0 km, y=1.0 km, z=2.0 km>
>>> sc = SkyCoord([1,2]*u.km, [3,4]*u.m, [5,6]*u.cm, frame="heliocentric",
obstime="2011/01/01T00:00:54")
>>> sc
<SkyCoord (HelioCentric): obstime=2011-01-01 00:00:54, D0=149597870.7 km,
(x, y, z) in (km, m, cm)
    [(1.0, 3.0, 5.0), (2.0, 4.0, 6.0)]>

Attributes Summary

default_differential
default_representation
frame_attributes
frame_specific_representation_info
name
observer
obstime

Attributes Documentation

default_differential
default_representation
frame_attributes = OrderedDict([('obstime', <sunpy.coordinates.frameattributes.TimeFrameAttributeSunPy object>), ('observer', <sunpy.coordinates.frameattributes.ObserverCoordinateAttribute object>)])
frame_specific_representation_info
name = 'heliocentric'
observer = 'earth'
obstime = None