.. include:: ../wcs/references.txt

WCS
===

.. currentmodule:: astropy.wcs

.. autoclass:: WCS
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~WCS.array_shape
      ~WCS.axis_correlation_matrix
      ~WCS.axis_type_names
      ~WCS.celestial
      ~WCS.cpdis1
      ~WCS.cpdis2
      ~WCS.det2im1
      ~WCS.det2im2
      ~WCS.has_celestial
      ~WCS.has_distortion
      ~WCS.has_spectral
      ~WCS.has_temporal
      ~WCS.is_celestial
      ~WCS.is_spectral
      ~WCS.is_temporal
      ~WCS.low_level_wcs
      ~WCS.pixel_axis_names
      ~WCS.pixel_bounds
      ~WCS.pixel_n_dim
      ~WCS.pixel_scale_matrix
      ~WCS.pixel_shape
      ~WCS.serialized_classes
      ~WCS.sip
      ~WCS.spectral
      ~WCS.temporal
      ~WCS.wcs
      ~WCS.world_axis_names
      ~WCS.world_axis_object_classes
      ~WCS.world_axis_object_components
      ~WCS.world_axis_physical_types
      ~WCS.world_axis_units
      ~WCS.world_n_dim

   .. rubric:: Methods Summary

   .. autosummary::

      ~WCS.all_pix2world
      ~WCS.all_world2pix
      ~WCS.array_index_to_world
      ~WCS.array_index_to_world_values
      ~WCS.calc_footprint
      ~WCS.copy
      ~WCS.deepcopy
      ~WCS.det2im
      ~WCS.dropaxis
      ~WCS.fix
      ~WCS.footprint_contains
      ~WCS.footprint_to_file
      ~WCS.get_axis_types
      ~WCS.p4_pix2foc
      ~WCS.pix2foc
      ~WCS.pixel_to_world
      ~WCS.pixel_to_world_values
      ~WCS.printwcs
      ~WCS.proj_plane_pixel_area
      ~WCS.proj_plane_pixel_scales
      ~WCS.reorient_celestial_first
      ~WCS.sip_foc2pix
      ~WCS.sip_pix2foc
      ~WCS.slice
      ~WCS.sub
      ~WCS.swapaxes
      ~WCS.to_fits
      ~WCS.to_header
      ~WCS.to_header_string
      ~WCS.wcs_pix2world
      ~WCS.wcs_world2pix
      ~WCS.world_to_array_index
      ~WCS.world_to_array_index_values
      ~WCS.world_to_pixel
      ~WCS.world_to_pixel_values

   .. rubric:: Attributes Documentation

   .. autoattribute:: array_shape
   .. autoattribute:: axis_correlation_matrix
   .. autoattribute:: axis_type_names
   .. autoattribute:: celestial
   .. autoattribute:: cpdis1
   .. autoattribute:: cpdis2
   .. autoattribute:: det2im1
   .. autoattribute:: det2im2
   .. autoattribute:: has_celestial
   .. autoattribute:: has_distortion
   .. autoattribute:: has_spectral
   .. autoattribute:: has_temporal
   .. autoattribute:: is_celestial
   .. autoattribute:: is_spectral
   .. autoattribute:: is_temporal
   .. autoattribute:: low_level_wcs
   .. autoattribute:: pixel_axis_names
   .. autoattribute:: pixel_bounds
   .. autoattribute:: pixel_n_dim
   .. autoattribute:: pixel_scale_matrix
   .. autoattribute:: pixel_shape
   .. autoattribute:: serialized_classes
   .. autoattribute:: sip
   .. autoattribute:: spectral
   .. autoattribute:: temporal
   .. autoattribute:: wcs
   .. autoattribute:: world_axis_names
   .. autoattribute:: world_axis_object_classes
   .. autoattribute:: world_axis_object_components
   .. autoattribute:: world_axis_physical_types
   .. autoattribute:: world_axis_units
   .. autoattribute:: world_n_dim

   .. rubric:: Methods Documentation

   .. automethod:: all_pix2world
   .. automethod:: all_world2pix
   .. automethod:: array_index_to_world
   .. automethod:: array_index_to_world_values
   .. automethod:: calc_footprint
   .. automethod:: copy
   .. automethod:: deepcopy
   .. automethod:: det2im
   .. automethod:: dropaxis
   .. automethod:: fix
   .. automethod:: footprint_contains
   .. automethod:: footprint_to_file
   .. automethod:: get_axis_types
   .. automethod:: p4_pix2foc
   .. automethod:: pix2foc
   .. automethod:: pixel_to_world
   .. automethod:: pixel_to_world_values
   .. automethod:: printwcs
   .. automethod:: proj_plane_pixel_area
   .. automethod:: proj_plane_pixel_scales
   .. automethod:: reorient_celestial_first
   .. automethod:: sip_foc2pix
   .. automethod:: sip_pix2foc
   .. automethod:: slice
   .. automethod:: sub
   .. automethod:: swapaxes
   .. automethod:: to_fits
   .. automethod:: to_header
   .. automethod:: to_header_string
   .. automethod:: wcs_pix2world
   .. automethod:: wcs_world2pix
   .. automethod:: world_to_array_index
   .. automethod:: world_to_array_index_values
   .. automethod:: world_to_pixel
   .. automethod:: world_to_pixel_values
