WCS
===

.. currentmodule:: gwcs.wcs

.. autoclass:: WCS
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~WCS.array_shape
      ~WCS.available_frames
      ~WCS.axis_correlation_matrix
      ~WCS.backward_transform
      ~WCS.bounding_box
      ~WCS.forward_transform
      ~WCS.input_frame
      ~WCS.low_level_wcs
      ~WCS.name
      ~WCS.output_frame
      ~WCS.pipeline
      ~WCS.pixel_axis_names
      ~WCS.pixel_bounds
      ~WCS.pixel_n_dim
      ~WCS.pixel_shape
      ~WCS.serialized_classes
      ~WCS.unit
      ~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.__call__
      ~WCS.array_index_to_world
      ~WCS.array_index_to_world_values
      ~WCS.attach_compound_bounding_box
      ~WCS.fix_inputs
      ~WCS.footprint
      ~WCS.get_transform
      ~WCS.in_image
      ~WCS.insert_frame
      ~WCS.insert_transform
      ~WCS.invert
      ~WCS.numerical_inverse
      ~WCS.out_of_bounds
      ~WCS.outside_footprint
      ~WCS.pixel_to_world
      ~WCS.pixel_to_world_values
      ~WCS.set_transform
      ~WCS.to_fits
      ~WCS.to_fits_sip
      ~WCS.to_fits_tab
      ~WCS.transform
      ~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:: available_frames
   .. autoattribute:: axis_correlation_matrix
   .. autoattribute:: backward_transform
   .. autoattribute:: bounding_box
   .. autoattribute:: forward_transform
   .. autoattribute:: input_frame
   .. autoattribute:: low_level_wcs
   .. autoattribute:: name
   .. autoattribute:: output_frame
   .. autoattribute:: pipeline
   .. autoattribute:: pixel_axis_names
   .. autoattribute:: pixel_bounds
   .. autoattribute:: pixel_n_dim
   .. autoattribute:: pixel_shape
   .. autoattribute:: serialized_classes
   .. autoattribute:: unit
   .. 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:: __call__
   .. automethod:: array_index_to_world
   .. automethod:: array_index_to_world_values
   .. automethod:: attach_compound_bounding_box
   .. automethod:: fix_inputs
   .. automethod:: footprint
   .. automethod:: get_transform
   .. automethod:: in_image
   .. automethod:: insert_frame
   .. automethod:: insert_transform
   .. automethod:: invert
   .. automethod:: numerical_inverse
   .. automethod:: out_of_bounds
   .. automethod:: outside_footprint
   .. automethod:: pixel_to_world
   .. automethod:: pixel_to_world_values
   .. automethod:: set_transform
   .. automethod:: to_fits
   .. automethod:: to_fits_sip
   .. automethod:: to_fits_tab
   .. automethod:: transform
   .. automethod:: world_to_array_index
   .. automethod:: world_to_array_index_values
   .. automethod:: world_to_pixel
   .. automethod:: world_to_pixel_values