GaussianBeam
============

.. currentmodule:: hcipy.optics

.. autoclass:: GaussianBeam
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~GaussianBeam.FWHM
      ~GaussianBeam.R
      ~GaussianBeam.beam_divergence
      ~GaussianBeam.beam_radius
      ~GaussianBeam.beam_waist
      ~GaussianBeam.complex_beam_parameter
      ~GaussianBeam.full_width_half_maximum
      ~GaussianBeam.gouy_phase
      ~GaussianBeam.k
      ~GaussianBeam.psi
      ~GaussianBeam.q
      ~GaussianBeam.radius_of_curvature
      ~GaussianBeam.rayleigh_distance
      ~GaussianBeam.theta
      ~GaussianBeam.w
      ~GaussianBeam.wavenumber
      ~GaussianBeam.zR

   .. rubric:: Methods Summary

   .. autosummary::

      ~GaussianBeam.__call__
      ~GaussianBeam.evaluate

   .. rubric:: Attributes Documentation

   .. autoattribute:: FWHM
   .. autoattribute:: R
   .. autoattribute:: beam_divergence
   .. autoattribute:: beam_radius
   .. autoattribute:: beam_waist
   .. autoattribute:: complex_beam_parameter
   .. autoattribute:: full_width_half_maximum
   .. autoattribute:: gouy_phase
   .. autoattribute:: k
   .. autoattribute:: psi
   .. autoattribute:: q
   .. autoattribute:: radius_of_curvature
   .. autoattribute:: rayleigh_distance
   .. autoattribute:: theta
   .. autoattribute:: w
   .. autoattribute:: wavenumber
   .. autoattribute:: zR

   .. rubric:: Methods Documentation

   .. automethod:: __call__
   .. automethod:: evaluate