RotatedSunFrame

class sunpy.coordinates.metaframes.RotatedSunFrame(*args, **kwargs)[source]

Bases: object

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

Note

See Differential rotation using coordinate frames for how to use this class.

In essence, the coordinate axes of the frame are distorted by differential solar rotation. This allows using a coordinate representation at one time (at the obstime of the base coordinate frame) to point to a location at a different time that has been differentially rotated by the time difference (duration).

Parameters
  • representation (BaseRepresentation or None) – A representation object or None to have no data. Alternatively, use coordinate component keyword arguments, which depend on the base frame.

  • base (SkyCoord or low-level coordinate object.) – The coordinate which specifies the base coordinate frame. The frame must be a SunPy frame.

  • duration (Quantity) – The duration of solar rotation (defaults to zero days).

  • rotated_time (tuple, str, pandas.Timestamp, pandas.Series, pandas.DatetimeIndex, datetime.datetime, datetime.date, numpy.datetime64, numpy.ndarray, astropy.time.Time) – The time to rotate the Sun to. If provided, duration will be set to the difference between this time and the observation time in base.

  • rotation_model (str) – Accepted model names are 'howard' (default), 'snodgrass', and 'allen'.

Notes

RotatedSunFrame is a factory class. That is, the objects that it yields are not actually objects of class RotatedSunFrame. Instead, distinct classes are created on-the-fly for whatever the frame class is of base.

Attributes Summary

base

duration

rotated_time

Returns the sum of the base frame’s observation time and the rotation of duration.

rotation_model

Methods Summary

as_base()

Returns a coordinate with the current representation and in the base coordinate frame.

Attributes Documentation

base = None
duration = <Quantity 0. d>
rotated_time

Returns the sum of the base frame’s observation time and the rotation of duration.

rotation_model = 'howard'

Methods Documentation

as_base()[source]

Returns a coordinate with the current representation and in the base coordinate frame.

This method can be thought of as “removing” the RotatedSunFrame layer. Be aware that this method is not merely a coordinate transformation, because this method changes the location in inertial space that is being pointed to.