gwcs.coordinate_frames._LegacyCoordinateFrameProtocol

class gwcs.coordinate_frames._LegacyCoordinateFrameProtocol(*args, **kwargs)

Bases: Protocol

Original API definition for a coordinate frame. This is used for deprecation warnings and to identify when to patch the is_high_level method to the frame.

Attributes

axes_names	Names describing the axes of the frame.
axes_order	The position of the axes in the frame in the transform.
axes_type	An upcase string (or tuple of strings) describing the type of the axis.
axis_physical_types	The UCD 1+ physical types for the axes, in frame order.
name	The name of the coordinate frame.
naxes	The number of axes described by this frame.
reference_frame	The reference frame of the coordinates described by this frame.
unit	The units of the axes in 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.

abstract property _LegacyCoordinateFrameProtocol.axes_names: tuple[str, ...]

Names describing the axes of the frame.

abstract property _LegacyCoordinateFrameProtocol.axes_order: tuple[int, ...]

The position of the axes in the frame in the transform.

abstract property _LegacyCoordinateFrameProtocol.axes_type: AxesType

An upcase string (or tuple of strings) describing the type of the axis.

See AxisType for the known values, but you can also use your own custom one.

abstract property _LegacyCoordinateFrameProtocol.axis_physical_types: tuple[str | None, ...]

The UCD 1+ physical types for the axes, in frame order.

abstract property _LegacyCoordinateFrameProtocol.name: str

The name of the coordinate frame.

abstract property _LegacyCoordinateFrameProtocol.naxes: int

The number of axes described by this frame.

abstract property _LegacyCoordinateFrameProtocol.reference_frame: AstropyBuiltInFrame | None

The reference frame of the coordinates described by this frame.

This is usually an Astropy object such as SkyCoord or Time.

abstract property _LegacyCoordinateFrameProtocol.unit: tuple[Unit | None, ...]

The units of the axes in this frame.

abstract property _LegacyCoordinateFrameProtocol.world_axis_object_classes: WorldAxisObjectClasses

The APE 14 object classes for this frame.

See also

astropy.wcs.wcsapi.BaseLowLevelWCS.world_axis_object_classes

abstract property _LegacyCoordinateFrameProtocol.world_axis_object_components: list[WorldAxisObjectComponent]

The APE 14 object components for this frame.

See also

astropy.wcs.wcsapi.BaseLowLevelWCS.world_axis_object_components

Methods

add_units(arrays)	Add units to the arrays
from_high_level_coordinates(*high_level_coords)	Convert high level coordinate objects to "values" as described by this frame.
remove_units(arrays)	Remove units from the input arrays
to_high_level_coordinates(*values[, correct_1d])	Convert "values" to high level coordinate objects described by this frame.

_LegacyCoordinateFrameProtocol.add_units(arrays)

Add units to the arrays

Parameters:

arrays (tuple[LowLevelInput, ...] | LowLevelInput)

Return type:

tuple[LowLevelInput, ...]

_LegacyCoordinateFrameProtocol.from_high_level_coordinates(*high_level_coords, correct_1d=True)

Convert high level coordinate objects to “values” as described by this frame.

“values” are the coordinates in array or scalar form, and high level objects are things such as SkyCoord or Quantity. See Shared Python Interface for World Coordinate Systems for details.

Parameters:

high_level_coordinates – One (or more) high level object describing the coordinate.

Returns:

values – naxis number of coordinates as scalars or arrays.

Return type:

numbers.Number or numpy.ndarray

_LegacyCoordinateFrameProtocol.remove_units(arrays)

Remove units from the input arrays

Parameters:

arrays (tuple[LowLevelInput, ...] | LowLevelInput)

Return type:

tuple[LowLevelArray, ...]

_LegacyCoordinateFrameProtocol.to_high_level_coordinates(*values, correct_1d=True)

Convert “values” to high level coordinate objects described by this frame.

“values” are the coordinates in array or scalar form, and high level objects are things such as SkyCoord or Quantity. See Shared Python Interface for World Coordinate Systems for details.

Parameters:

values (numbers.Number, numpy.ndarray, or Quantity) – naxis number of coordinates as scalars or arrays.

Returns:

high_level_coordinates – One (or more) high level object describing the coordinate.

Return type:

object