Rays
====

.. currentmodule:: kgpy.optics.rays

.. autoclass:: kgpy.optics.rays.Rays
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :member-order: groupwise

    .. automethod:: __init__

    
    
    .. rubric:: Attributes

    .. autosummary::
    
      ~Rays.aberration
      ~Rays.axis
      ~Rays.base_shape
      ~Rays.distortion
      ~Rays.distortion_polynomial_degree
      ~Rays.energy
      ~Rays.error_mask
      ~Rays.field_angles
      ~Rays.grid_shape
      ~Rays.index_of_refraction
      ~Rays.input_grid
      ~Rays.intensity
      ~Rays.mask
      ~Rays.ndim
      ~Rays.num_wavlength
      ~Rays.position_apparent
      ~Rays.position_avg_pupil
      ~Rays.position_relative_pupil
      ~Rays.shape
      ~Rays.size
      ~Rays.spot_size_rms
      ~Rays.tol_iter
      ~Rays.transformed
      ~Rays.velocity_los
      ~Rays.vignetted_mask
      ~Rays.vignetting
      ~Rays.vignetting_polynomial_degree
      ~Rays.wavelength
      ~Rays.position
      ~Rays.direction
      ~Rays.surface_normal
      ~Rays.transform
    
    

    
    
    .. rubric:: Methods

    .. autosummary::
    
      ~Rays.__init__
      ~Rays.apply_transform_list
      ~Rays.calc_labels
      ~Rays.calc_mtf
      ~Rays.colorgrid
      ~Rays.colormesh
      ~Rays.copy
      ~Rays.copy_shallow
      ~Rays.from_field_angles
      ~Rays.from_field_positions
      ~Rays.grid_labels
      ~Rays.mtf
      ~Rays.plot_attribute
      ~Rays.plot_direction
      ~Rays.plot_position
      ~Rays.plot_pupil_hist2d_vs_field
      ~Rays.plot_spot_size_vs_field
      ~Rays.pupil_hist2d
    
    

    
    .. rubric:: Inheritance Diagram

    .. inheritance-diagram:: kgpy.optics.rays.Rays