CoordinateFrame

class gwcs.coordinate_frames.CoordinateFrame(naxes: int, axes_type: tuple[AxisType | str, ...] | AxisType | str, axes_order: tuple[int, ...], reference_frame: Time | BaseCoordinateFrame | None = None, unit: tuple[Unit, ...] | None = None, axes_names: tuple[str, ...] | None = None, name: str | None = None, axis_physical_types: tuple[str | None, ...] | None = None)

Bases: CoordinateFrameProtocol

Base class for Coordinate Frames.

Parameters:

naxesint

Number of axes.

axes_typeAxesType

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

axes_ordertuple of int

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

reference_frameastropy.coordinates.builtin_frames

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

unitlist of astropy.units.Unit

Unit for each axis.

axes_nameslist

Names of the axes in this frame.

namestr

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	The axis physical types for this frame.
name	A custom name of this frame.
naxes	The number of axes in this frame.
raw_properties	The raw FrameProperties object for this frame.
reference_frame	Reference frame, used to convert to world coordinate objects.
serialized_classes	This property is used by the low level WCS API in Astropy.
unit	The unit of this frame.
world_axis_object_classes	The APE 14 object classes for this frame.
world_axis_object_components	The APE 14 object components for this frame.

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

The axis physical types for this frame.

These physical types are the types in frame order, not transform order.

name

A custom name of this frame.

naxes

The number of axes in this frame.

raw_properties

The raw FrameProperties object for this frame.

reference_frame

Reference frame, used to convert to world coordinate objects.

serialized_classes

This property is used by the low level WCS API in Astropy.

By providing it we can duck type as a low level WCS object.

unit

The unit of this frame.

world_axis_object_classes

world_axis_object_components

The APE 14 object components for this frame.

See also

astropy.wcs.wcsapi.BaseLowLevelWCS.world_axis_object_components