Grid
====

.. currentmodule:: hcipy.field

.. autoclass:: Grid
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Grid.delta
      ~Grid.dims
      ~Grid.is_regular
      ~Grid.is_separated
      ~Grid.is_unstructured
      ~Grid.ndim
      ~Grid.points
      ~Grid.regular_coords
      ~Grid.separated_coords
      ~Grid.shape
      ~Grid.size
      ~Grid.weights
      ~Grid.zero

   .. rubric:: Methods Summary

   .. autosummary::

      ~Grid.as_
      ~Grid.closest_to
      ~Grid.copy
      ~Grid.empty
      ~Grid.from_dict
      ~Grid.is_
      ~Grid.ones
      ~Grid.reverse
      ~Grid.reversed
      ~Grid.rotate
      ~Grid.rotated
      ~Grid.scale
      ~Grid.scaled
      ~Grid.shift
      ~Grid.shifted
      ~Grid.subset
      ~Grid.to_dict
      ~Grid.zeros

   .. rubric:: Attributes Documentation

   .. autoattribute:: delta
   .. autoattribute:: dims
   .. autoattribute:: is_regular
   .. autoattribute:: is_separated
   .. autoattribute:: is_unstructured
   .. autoattribute:: ndim
   .. autoattribute:: points
   .. autoattribute:: regular_coords
   .. autoattribute:: separated_coords
   .. autoattribute:: shape
   .. autoattribute:: size
   .. autoattribute:: weights
   .. autoattribute:: zero

   .. rubric:: Methods Documentation

   .. automethod:: as_
   .. automethod:: closest_to
   .. automethod:: copy
   .. automethod:: empty
   .. automethod:: from_dict
   .. automethod:: is_
   .. automethod:: ones
   .. automethod:: reverse
   .. automethod:: reversed
   .. automethod:: rotate
   .. automethod:: rotated
   .. automethod:: scale
   .. automethod:: scaled
   .. automethod:: shift
   .. automethod:: shifted
   .. automethod:: subset
   .. automethod:: to_dict
   .. automethod:: zeros