Skip to main content
`Ctrl`+`K`

# BaseEclipticFrame

class astropy.coordinates.BaseEclipticFrame(*args, copy=True, representation_type=None, differential_type=None, **kwargs)

  Bases: `BaseCoordinateFrame`

  A base class for frames that have names and conventions like that of ecliptic frames.

  Warning

  In the current version of astropy, the ecliptic frames do not yet have stringent accuracy tests. We recommend you test to “known-good” cases to ensure this frames are what you are looking for. (and then ideally you would contribute these tests to Astropy!)

  Parameters:
    data `BaseRepresentation` subclass instance

      A representation object or `None` to have no data (or use the coordinate component arguments, see below).

    lon `Angle`, optional, keyword-only

      The ecliptic longitude for this object (`lat` must also be given and `representation` must be None).

    lat `Angle`, optional, keyword-only

      The ecliptic latitude for this object (`lon` must also be given and `representation` must be None).

    distance `Quantity` [:ref: ‘length’], optional, keyword-only

      The distance for this object from the specified location. (`representation` must be None).

    pm_lon_coslat `Quantity` [‘angualar speed’], optional, keyword-only

      The proper motion in the ecliptic longitude (including the `cos(lat)` factor) for this object (`pm_lat` must also be given).

    pm_lat `Quantity` [:ref: ‘angular speed’], optional, keyword-only

      The proper motion in the ecliptic latitude for this object (`pm_lon_coslat` must also be given).

    radial_velocity `Quantity` [:ref: ‘speed’], optional, keyword-only

      The radial velocity of this object.

    representation_type `BaseRepresentation` subclass, `python:str`, optional

      A representation class or string name of a representation class. This sets the expected input representation class, thereby changing the expected keyword arguments for the data passed in. For example, passing `representation_type='cartesian'` will make the classes expect position data with cartesian names, i.e. `x, y, z` in most cases unless overridden via `frame_specific_representation_info`. To see this frame’s names, check out `<this frame>().representation_info`.

    differential_type `BaseDifferential` subclass, `python:str`, `python:dict`, optional

      A differential class or dictionary of differential classes (currently only a velocity differential with key ‘s’ is supported). This sets the expected input differential class, thereby changing the expected keyword arguments of the data passed in. For example, passing `differential_type='cartesian'` will make the classes expect velocity data with the argument names `v_x, v_y, v_z` unless overridden via `frame_specific_representation_info`. To see this frame’s names, check out `<this frame>().representation_info`.

    copy bool, optional

      If `True` (default), make copies of the input coordinate arrays. Can only be passed in as a keyword argument.

  Attributes Summary

  `default_differential` | Default representation for differential data (e.g., velocity)
  `default_representation` | Default representation for position data
  `frame_attributes` |
  `frame_specific_representation_info` | Mapping for frame-specific component names
  `name` |

  Attributes Documentation

  default_differential

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

  default_representation

    Default representation for position data

  frame_attributes = {}
  frame_specific_representation_info

    Mapping for frame-specific component names

  name = 'baseeclipticframe'