PupilVector
===========

.. currentmodule:: kgpy.optics.vectors

.. autoclass:: kgpy.optics.vectors.PupilVector
    :members:
    :show-inheritance:
    :inherited-members:
    :undoc-members:
    :member-order: groupwise

    .. automethod:: __init__

    
    
    .. rubric:: Attributes

    .. autosummary::
    
      ~PupilVector.array
      ~PupilVector.array_labeled
      ~PupilVector.broadcasted
      ~PupilVector.centers
      ~PupilVector.component_sum
      ~PupilVector.components
      ~PupilVector.coordinates
      ~PupilVector.dtype
      ~PupilVector.indices
      ~PupilVector.length
      ~PupilVector.ndim
      ~PupilVector.normalize
      ~PupilVector.normalized
      ~PupilVector.pupil_x
      ~PupilVector.pupil_xy
      ~PupilVector.pupil_y
      ~PupilVector.shape
      ~PupilVector.tuple
      ~PupilVector.type_coordinates
      ~PupilVector.type_matrix
      ~PupilVector.unit
    
    

    
    
    .. rubric:: Methods

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

    
    .. rubric:: Inheritance Diagram

    .. inheritance-diagram:: kgpy.optics.vectors.PupilVector