RayVector
=========

.. currentmodule:: kgpy.optics.rays

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

    .. automethod:: __init__

    
    
    .. rubric:: Attributes

    .. autosummary::
    
      ~RayVector.angles
      ~RayVector.array
      ~RayVector.array_labeled
      ~RayVector.broadcasted
      ~RayVector.centers
      ~RayVector.component_sum
      ~RayVector.components
      ~RayVector.coordinates
      ~RayVector.dtype
      ~RayVector.energy
      ~RayVector.index_refraction
      ~RayVector.indices
      ~RayVector.intensity
      ~RayVector.length
      ~RayVector.ndim
      ~RayVector.normalize
      ~RayVector.normalized
      ~RayVector.position_average_pupil
      ~RayVector.position_relative_pupil
      ~RayVector.shape
      ~RayVector.spot_size_rms
      ~RayVector.transformed
      ~RayVector.tuple
      ~RayVector.type_coordinates
      ~RayVector.type_matrix
      ~RayVector.unit
      ~RayVector.wavelength
      ~RayVector.position
      ~RayVector.direction
      ~RayVector.polarization
      ~RayVector.surface_normal
      ~RayVector.mask
      ~RayVector.transform
    
    

    
    
    .. rubric:: Methods

    .. autosummary::
    
      ~RayVector.__init__
      ~RayVector.add_axes
      ~RayVector.aligned
      ~RayVector.all
      ~RayVector.any
      ~RayVector.apply_transform
      ~RayVector.astype
      ~RayVector.broadcast_to
      ~RayVector.combine_axes
      ~RayVector.copy
      ~RayVector.copy_shallow
      ~RayVector.from_coordinates
      ~RayVector.from_field_angles
      ~RayVector.index
      ~RayVector.index_below_brute
      ~RayVector.index_nearest_brute
      ~RayVector.index_nearest_secant
      ~RayVector.index_secant
      ~RayVector.interp_linear
      ~RayVector.linear_space
      ~RayVector.max
      ~RayVector.mean
      ~RayVector.min
      ~RayVector.ndindex
      ~RayVector.outer
      ~RayVector.plot
      ~RayVector.plot_filled
      ~RayVector.prototype
      ~RayVector.ptp
      ~RayVector.reshape
      ~RayVector.rms
      ~RayVector.std
      ~RayVector.stratified_random_space
      ~RayVector.sum
      ~RayVector.to
      ~RayVector.to_matrix
    
    

    
    .. rubric:: Inheritance Diagram

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