CoordinateFrame

class gwcs.coordinate_frames.CoordinateFrame(naxes, axes_type, axes_order, reference_frame=None, reference_position=None, unit=None, axes_names=None, name=None, axis_physical_types=None)

Bases: object

Base class for Coordinate Frames.

Parameters:

naxes : int

Number of axes.

axes_type : str

One of [“SPATIAL”, “SPECTRAL”, “TIME”]

axes_order : tuple of int

A dimension in the input data that corresponds to this axis.

reference_frame : astropy.coordinates.builtin_frames

Reference frame (usually used with output_frame to convert to world coordinate objects).

reference_position : str

Reference position - one of STANDARD_REFERENCE_POSITION

unit : list of astropy.units.Unit

Unit for each axis.

axes_names : list

Names of the axes in this frame.

name : str

Name of this frame.

Attributes Summary

axes_names	Names of axes in the frame.
axes_order	A tuple of indices which map inputs to axes.
axes_type	Type of this frame : ‘SPATIAL’, ‘SPECTRAL’, ‘TIME’.
axis_physical_types
name	A custom name of this frame.
naxes	The number of axes in this frame.
reference_frame	Reference frame, used to convert to world coordinate objects.
reference_position	Reference Position.
unit	The unit of this frame.

Methods Summary

coordinate_to_quantity(*coords)	Given a rich coordinate object return an astropy quantity object.
coordinates(*args)	Create world coordinates object

Attributes Documentation

axes_names

Names of axes in the frame.

axes_order

A tuple of indices which map inputs to axes.

axes_type

Type of this frame : ‘SPATIAL’, ‘SPECTRAL’, ‘TIME’.

axis_physical_types

name

A custom name of this frame.

naxes

The number of axes in this frame.

reference_frame

Reference frame, used to convert to world coordinate objects.

reference_position

Reference Position.

unit

The unit of this frame.

Methods Documentation

coordinate_to_quantity(*coords)

Given a rich coordinate object return an astropy quantity object.

coordinates(*args)

Create world coordinates object