Gaussian2D
==========

.. currentmodule:: sofia_redux.scan.source_models.beams.gaussian_2d

.. autoclass:: Gaussian2D
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Gaussian2D.AREA_FACTOR
      ~Gaussian2D.FWHM_TO_SIZE
      ~Gaussian2D.QUARTER
      ~Gaussian2D.area
      ~Gaussian2D.fwhm
      ~Gaussian2D.major_fwhm
      ~Gaussian2D.minor_fwhm
      ~Gaussian2D.peak
      ~Gaussian2D.position_angle
      ~Gaussian2D.referenced_attributes
      ~Gaussian2D.theta
      ~Gaussian2D.x_fwhm
      ~Gaussian2D.x_mean
      ~Gaussian2D.x_stddev
      ~Gaussian2D.y_fwhm
      ~Gaussian2D.y_mean
      ~Gaussian2D.y_stddev

   .. rubric:: Methods Summary

   .. autosummary::

      ~Gaussian2D.combine_with
      ~Gaussian2D.convolve_with
      ~Gaussian2D.copy
      ~Gaussian2D.deconvolve_with
      ~Gaussian2D.edit_header
      ~Gaussian2D.encompass
      ~Gaussian2D.extent
      ~Gaussian2D.get_beam_map
      ~Gaussian2D.get_circular_equivalent_fwhm
      ~Gaussian2D.get_equivalent
      ~Gaussian2D.is_circular
      ~Gaussian2D.is_encompassing
      ~Gaussian2D.parse_header
      ~Gaussian2D.rotate
      ~Gaussian2D.scale
      ~Gaussian2D.set_area
      ~Gaussian2D.set_equivalent
      ~Gaussian2D.set_xy_fwhm
      ~Gaussian2D.validate

   .. rubric:: Attributes Documentation

   .. autoattribute:: AREA_FACTOR
   .. autoattribute:: FWHM_TO_SIZE
   .. autoattribute:: QUARTER
   .. autoattribute:: area
   .. autoattribute:: fwhm
   .. autoattribute:: major_fwhm
   .. autoattribute:: minor_fwhm
   .. autoattribute:: peak
   .. autoattribute:: position_angle
   .. autoattribute:: referenced_attributes
   .. autoattribute:: theta
   .. autoattribute:: x_fwhm
   .. autoattribute:: x_mean
   .. autoattribute:: x_stddev
   .. autoattribute:: y_fwhm
   .. autoattribute:: y_mean
   .. autoattribute:: y_stddev

   .. rubric:: Methods Documentation

   .. automethod:: combine_with
   .. automethod:: convolve_with
   .. automethod:: copy
   .. automethod:: deconvolve_with
   .. automethod:: edit_header
   .. automethod:: encompass
   .. automethod:: extent
   .. automethod:: get_beam_map
   .. automethod:: get_circular_equivalent_fwhm
   .. automethod:: get_equivalent
   .. automethod:: is_circular
   .. automethod:: is_encompassing
   .. automethod:: parse_header
   .. automethod:: rotate
   .. automethod:: scale
   .. automethod:: set_area
   .. automethod:: set_equivalent
   .. automethod:: set_xy_fwhm
   .. automethod:: validate