Vignetting
==========

.. currentmodule:: kgpy.optics.aberration

.. autoclass:: kgpy.optics.aberration.Vignetting
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :member-order: groupwise

    .. automethod:: __init__

    
    
    .. rubric:: Attributes

    .. autosummary::
    
      ~Vignetting.mesh
      ~Vignetting.polynomial_degree
      ~Vignetting.wavelength
      ~Vignetting.spatial_mesh
      ~Vignetting.unvignetted_percent
      ~Vignetting.mask
    
    

    
    
    .. rubric:: Methods

    .. autosummary::
    
      ~Vignetting.__init__
      ~Vignetting.apply_model
      ~Vignetting.model
      ~Vignetting.plot
      ~Vignetting.plot_residual
      ~Vignetting.plot_unvignetted
      ~Vignetting.residual
    
    

    
    .. rubric:: Inheritance Diagram

    .. inheritance-diagram:: kgpy.optics.aberration.Vignetting