Wavefront
=========

.. currentmodule:: hcipy.optics

.. autoclass:: Wavefront
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Wavefront.I
      ~Wavefront.Q
      ~Wavefront.U
      ~Wavefront.V
      ~Wavefront.amplitude
      ~Wavefront.angle_of_linear_polarization
      ~Wavefront.degree_of_circular_polarization
      ~Wavefront.degree_of_linear_polarization
      ~Wavefront.degree_of_polarization
      ~Wavefront.electric_field
      ~Wavefront.ellipticity
      ~Wavefront.grid
      ~Wavefront.imag
      ~Wavefront.input_stokes_vector
      ~Wavefront.intensity
      ~Wavefront.is_partially_polarized
      ~Wavefront.is_polarized
      ~Wavefront.is_scalar
      ~Wavefront.phase
      ~Wavefront.power
      ~Wavefront.real
      ~Wavefront.stokes_vector
      ~Wavefront.total_power
      ~Wavefront.wavenumber

   .. rubric:: Methods Summary

   .. autosummary::

      ~Wavefront.copy

   .. rubric:: Attributes Documentation

   .. autoattribute:: I
   .. autoattribute:: Q
   .. autoattribute:: U
   .. autoattribute:: V
   .. autoattribute:: amplitude
   .. autoattribute:: angle_of_linear_polarization
   .. autoattribute:: degree_of_circular_polarization
   .. autoattribute:: degree_of_linear_polarization
   .. autoattribute:: degree_of_polarization
   .. autoattribute:: electric_field
   .. autoattribute:: ellipticity
   .. autoattribute:: grid
   .. autoattribute:: imag
   .. autoattribute:: input_stokes_vector
   .. autoattribute:: intensity
   .. autoattribute:: is_partially_polarized
   .. autoattribute:: is_polarized
   .. autoattribute:: is_scalar
   .. autoattribute:: phase
   .. autoattribute:: power
   .. autoattribute:: real
   .. autoattribute:: stokes_vector
   .. autoattribute:: total_power
   .. autoattribute:: wavenumber

   .. rubric:: Methods Documentation

   .. automethod:: copy