BaseHighLevelWCS¶

class
astropy.wcs.wcsapi.
BaseHighLevelWCS
[source]¶ Bases:
object
Abstract base class for the highlevel WCS interface.
This is described in APE 14: A shared Python interface for World Coordinate Systems.
Attributes Summary
Returns a reference to the underlying lowlevel WCS object.
Methods Summary
array_index_to_world
(self, \*index_arrays)Convert array indices to world coordinates (represented by Astropy objects).
pixel_to_world
(self, \*pixel_arrays)Convert pixel coordinates to world coordinates (represented by highlevel objects).
world_to_array_index
(self, \*world_objects)Convert world coordinates (represented by Astropy objects) to array indices.
world_to_pixel
(self, \*world_objects)Convert world coordinates (represented by Astropy objects) to pixel coordinates.
Attributes Documentation

low_level_wcs
¶ Returns a reference to the underlying lowlevel WCS object.
Methods Documentation

abstract
array_index_to_world
(self, *index_arrays)[source]¶ Convert array indices to world coordinates (represented by Astropy objects).
If a single highlevel object is used to represent the world coordinates (i.e., if
len(wcs.world_axis_object_classes) == 1
), it is returned asis (not in a tuple/list), otherwise a tuple of highlevel objects is returned. Seearray_index_to_world_values
for pixel indexing and ordering conventions.

abstract
pixel_to_world
(self, *pixel_arrays)[source]¶ Convert pixel coordinates to world coordinates (represented by highlevel objects).
If a single highlevel object is used to represent the world coordinates (i.e., if
len(wcs.world_axis_object_classes) == 1
), it is returned asis (not in a tuple/list), otherwise a tuple of highlevel objects is returned. Seepixel_to_world_values
for pixel indexing and ordering conventions.

abstract
world_to_array_index
(self, *world_objects)[source]¶ Convert world coordinates (represented by Astropy objects) to array indices.
If
pixel_n_dim
is1
, this method returns a single scalar or array, otherwise a tuple of scalars or arrays is returned. Seeworld_to_array_index_values
for pixel indexing and ordering conventions. The indices should be returned as rounded integers.

abstract
world_to_pixel
(self, *world_objects)[source]¶ Convert world coordinates (represented by Astropy objects) to pixel coordinates.
If
pixel_n_dim
is1
, this method returns a single scalar or array, otherwise a tuple of scalars or arrays is returned. Seeworld_to_pixel_values
for pixel indexing and ordering conventions.
