FieldVector
===========

.. currentmodule:: kgpy.optics.vectors

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

    .. automethod:: __init__

    
    
    .. rubric:: Attributes

    .. autosummary::
    
      ~FieldVector.array
      ~FieldVector.array_labeled
      ~FieldVector.broadcasted
      ~FieldVector.centers
      ~FieldVector.component_sum
      ~FieldVector.components
      ~FieldVector.coordinates
      ~FieldVector.dtype
      ~FieldVector.field_x
      ~FieldVector.field_xy
      ~FieldVector.field_y
      ~FieldVector.indices
      ~FieldVector.length
      ~FieldVector.ndim
      ~FieldVector.normalize
      ~FieldVector.normalized
      ~FieldVector.shape
      ~FieldVector.tuple
      ~FieldVector.type_coordinates
      ~FieldVector.type_matrix
      ~FieldVector.unit
    
    

    
    
    .. rubric:: Methods

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

    
    .. rubric:: Inheritance Diagram

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