Map2D
=====

.. currentmodule:: sofia_redux.scan.source_models.maps.map_2d

.. autoclass:: Map2D
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Map2D.CORRECTED_BEAM_FITS_ID
      ~Map2D.FILTER_BEAM_FITS_ID
      ~Map2D.SMOOTHING_BEAM_FITS_ID
      ~Map2D.UNDERLYING_BEAM_FITS_ID
      ~Map2D.pixel_area
      ~Map2D.projection
      ~Map2D.reference
      ~Map2D.reference_index

   .. rubric:: Methods Summary

   .. autosummary::

      ~Map2D.add_proprietary_units
      ~Map2D.add_smoothing
      ~Map2D.auto_crop
      ~Map2D.claim_image
      ~Map2D.convert_range_value_to_index
      ~Map2D.copy
      ~Map2D.copy_processing_from
      ~Map2D.copy_properties_from
      ~Map2D.count_beams
      ~Map2D.count_independent_points
      ~Map2D.crop
      ~Map2D.default_beam
      ~Map2D.edit_coordinate_info
      ~Map2D.edit_header
      ~Map2D.fast_smooth
      ~Map2D.fft_filter_above
      ~Map2D.filter_above
      ~Map2D.filter_beam_correct
      ~Map2D.filter_correct
      ~Map2D.get_anti_aliasing_beam_for
      ~Map2D.get_anti_aliasing_beam_image_for
      ~Map2D.get_area
      ~Map2D.get_default_grid_unit
      ~Map2D.get_display_grid_unit
      ~Map2D.get_filter_area
      ~Map2D.get_filter_correction_factor
      ~Map2D.get_image
      ~Map2D.get_image_beam
      ~Map2D.get_image_beam_area
      ~Map2D.get_index_transform_to
      ~Map2D.get_info
      ~Map2D.get_pixel_smoothing
      ~Map2D.get_points_per_smoothing_beam
      ~Map2D.get_resolution
      ~Map2D.get_table_entry
      ~Map2D.is_corrected
      ~Map2D.is_filter_blanked
      ~Map2D.is_filtered
      ~Map2D.merge_properties_from
      ~Map2D.nearest_to_offset
      ~Map2D.no_data
      ~Map2D.numpy_to_fits
      ~Map2D.parse_coordinate_info
      ~Map2D.parse_corrected_beam
      ~Map2D.parse_filter_beam
      ~Map2D.parse_header
      ~Map2D.parse_smoothing_beam
      ~Map2D.parse_underlying_beam
      ~Map2D.renew
      ~Map2D.resample
      ~Map2D.resample_from_map
      ~Map2D.reset_filtering
      ~Map2D.reset_processing
      ~Map2D.reset_smoothing
      ~Map2D.set_correcting_fwhm
      ~Map2D.set_default_unit
      ~Map2D.set_display_grid_unit
      ~Map2D.set_filter_blanking
      ~Map2D.set_filtering
      ~Map2D.set_grid
      ~Map2D.set_image
      ~Map2D.set_pixel_smoothing
      ~Map2D.set_resolution
      ~Map2D.set_smoothing
      ~Map2D.set_underlying_beam
      ~Map2D.set_unit
      ~Map2D.smooth
      ~Map2D.smooth_to
      ~Map2D.smooth_with_psf
      ~Map2D.undo_filter_correct
      ~Map2D.update_filtering

   .. rubric:: Attributes Documentation

   .. autoattribute:: CORRECTED_BEAM_FITS_ID
   .. autoattribute:: FILTER_BEAM_FITS_ID
   .. autoattribute:: SMOOTHING_BEAM_FITS_ID
   .. autoattribute:: UNDERLYING_BEAM_FITS_ID
   .. autoattribute:: pixel_area
   .. autoattribute:: projection
   .. autoattribute:: reference
   .. autoattribute:: reference_index

   .. rubric:: Methods Documentation

   .. automethod:: add_proprietary_units
   .. automethod:: add_smoothing
   .. automethod:: auto_crop
   .. automethod:: claim_image
   .. automethod:: convert_range_value_to_index
   .. automethod:: copy
   .. automethod:: copy_processing_from
   .. automethod:: copy_properties_from
   .. automethod:: count_beams
   .. automethod:: count_independent_points
   .. automethod:: crop
   .. automethod:: default_beam
   .. automethod:: edit_coordinate_info
   .. automethod:: edit_header
   .. automethod:: fast_smooth
   .. automethod:: fft_filter_above
   .. automethod:: filter_above
   .. automethod:: filter_beam_correct
   .. automethod:: filter_correct
   .. automethod:: get_anti_aliasing_beam_for
   .. automethod:: get_anti_aliasing_beam_image_for
   .. automethod:: get_area
   .. automethod:: get_default_grid_unit
   .. automethod:: get_display_grid_unit
   .. automethod:: get_filter_area
   .. automethod:: get_filter_correction_factor
   .. automethod:: get_image
   .. automethod:: get_image_beam
   .. automethod:: get_image_beam_area
   .. automethod:: get_index_transform_to
   .. automethod:: get_info
   .. automethod:: get_pixel_smoothing
   .. automethod:: get_points_per_smoothing_beam
   .. automethod:: get_resolution
   .. automethod:: get_table_entry
   .. automethod:: is_corrected
   .. automethod:: is_filter_blanked
   .. automethod:: is_filtered
   .. automethod:: merge_properties_from
   .. automethod:: nearest_to_offset
   .. automethod:: no_data
   .. automethod:: numpy_to_fits
   .. automethod:: parse_coordinate_info
   .. automethod:: parse_corrected_beam
   .. automethod:: parse_filter_beam
   .. automethod:: parse_header
   .. automethod:: parse_smoothing_beam
   .. automethod:: parse_underlying_beam
   .. automethod:: renew
   .. automethod:: resample
   .. automethod:: resample_from_map
   .. automethod:: reset_filtering
   .. automethod:: reset_processing
   .. automethod:: reset_smoothing
   .. automethod:: set_correcting_fwhm
   .. automethod:: set_default_unit
   .. automethod:: set_display_grid_unit
   .. automethod:: set_filter_blanking
   .. automethod:: set_filtering
   .. automethod:: set_grid
   .. automethod:: set_image
   .. automethod:: set_pixel_smoothing
   .. automethod:: set_resolution
   .. automethod:: set_smoothing
   .. automethod:: set_underlying_beam
   .. automethod:: set_unit
   .. automethod:: smooth
   .. automethod:: smooth_to
   .. automethod:: smooth_with_psf
   .. automethod:: undo_filter_correct
   .. automethod:: update_filtering