shareloc.geofunctions.rectification_grid
========================================

.. py:module:: shareloc.geofunctions.rectification_grid

.. autoapi-nested-parse::

   This module contains the rectification_grids class to handle CARS rectification grids.



Classes
-------

.. autoapisummary::

   shareloc.geofunctions.rectification_grid.RectificationGrid


Module Contents
---------------

.. py:class:: RectificationGrid(grid_filename, is_displacement_grid = False, interpolator = 'linear')

   Rectification grid


   .. py:attribute:: grid_filename


   .. py:attribute:: points


   .. py:attribute:: interpolator


   .. py:method:: get_positions()

      return grid positions

      :return grid positions
      :rtype  numpy array, numpy array



   .. py:method:: interpolate(positions)

      interpolate position

      :param positions : positions to interpolate : array  Nx2 [col,row]
      :type positions: np.array
      :return interpolated positions : array  Nx2 [col,row]
      :rtype  np.array