Surface
=======

.. currentmodule:: kgpy.optics.surfaces

.. autoclass:: kgpy.optics.surfaces.Surface
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :member-order: groupwise

    .. automethod:: __init__

    
    
    .. rubric:: Attributes

    .. autosummary::
    
      ~Surface.aperture
      ~Surface.aperture_mechanical
      ~Surface.broadcasted
      ~Surface.dataframe
      ~Surface.is_active
      ~Surface.is_field_stop
      ~Surface.is_pupil_stop
      ~Surface.is_pupil_stop_test
      ~Surface.is_visible
      ~Surface.material
      ~Surface.name
      ~Surface.ruling
      ~Surface.sag
      ~Surface.shape
      ~Surface.plot_kwargs
      ~Surface.baffle_loft_ids
      ~Surface.transform
    
    

    
    
    .. rubric:: Methods

    .. autosummary::
    
      ~Surface.__init__
      ~Surface.copy
      ~Surface.copy_shallow
      ~Surface.plot
      ~Surface.propagate_rays
      ~Surface.ray_intercept
      ~Surface.write_to_dxf
    
    

    
    .. rubric:: Inheritance Diagram

    .. inheritance-diagram:: kgpy.optics.surfaces.Surface