opendrift.readers.interpolation
===============================

.. py:module:: opendrift.readers.interpolation


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/opendrift/readers/interpolation/interpolators/index
   /autoapi/opendrift/readers/interpolation/structured/index


Attributes
----------

.. autoapisummary::

   opendrift.readers.interpolation.logger
   opendrift.readers.interpolation.horizontal_interpolation_methods
   opendrift.readers.interpolation.vertical_interpolation_methods


Classes
-------

.. autoapisummary::

   opendrift.readers.interpolation.Nearest2DInterpolator
   opendrift.readers.interpolation.NDImage2DInterpolator
   opendrift.readers.interpolation.LinearND2DInterpolator
   opendrift.readers.interpolation.Linear2DInterpolator
   opendrift.readers.interpolation.Nearest1DInterpolator
   opendrift.readers.interpolation.Linear1DInterpolator
   opendrift.readers.interpolation.ReaderBlock


Functions
---------

.. autoapisummary::

   opendrift.readers.interpolation.expand_numpy_array
   opendrift.readers.interpolation.fill_NaN_towards_seafloor


Package Contents
----------------

.. py:data:: logger

.. py:function:: expand_numpy_array(data)

.. py:class:: Nearest2DInterpolator(xgrid, ygrid, x, y)

   .. py:attribute:: x


   .. py:attribute:: y


   .. py:attribute:: xi


   .. py:attribute:: yi


   .. py:method:: __call__(array2d)


.. py:class:: NDImage2DInterpolator(xgrid, ygrid, x, y)

   .. py:attribute:: x


   .. py:attribute:: y


   .. py:attribute:: xi


   .. py:attribute:: yi


   .. py:method:: __call__(array2d)


.. py:class:: LinearND2DInterpolator(xgrid, ygrid, x, y)

   .. py:attribute:: block_x


   .. py:attribute:: block_y


   .. py:attribute:: x


   .. py:attribute:: y


   .. py:method:: __call__(array2d)


.. py:class:: Linear2DInterpolator(xgrid, ygrid, x, y)

   .. py:attribute:: x


   .. py:attribute:: y


   .. py:attribute:: xi


   .. py:attribute:: yi


   .. py:method:: __call__(array2d)


.. py:data:: horizontal_interpolation_methods

.. py:class:: Nearest1DInterpolator(zgrid, z)

   .. py:attribute:: zi


   .. py:method:: __call__(array2d)


.. py:class:: Linear1DInterpolator(zgrid, z)

   .. py:attribute:: index_above


   .. py:attribute:: index_below


   .. py:attribute:: weight_above


   .. py:attribute:: xi


   .. py:method:: __call__(array2d)


.. py:data:: vertical_interpolation_methods

.. py:function:: fill_NaN_towards_seafloor(array)

   Extrapolate NaN-values (missing) towards seafloor


.. py:class:: ReaderBlock(data_dict, interpolation_horizontal='linearNDFast', interpolation_vertical='linear', wrap_x=False)

   Class to store and interpolate the output from a reader with data on a regular (structured) grid.


   .. py:attribute:: x


   .. py:attribute:: y


   .. py:attribute:: time


   .. py:attribute:: data_dict


   .. py:attribute:: wrap_x
      :value: False



   .. py:method:: _initialize_interpolator(x, y, z=None)


   .. py:method:: interpolate(x, y, z=None, variables=None, profiles=[], profiles_depth=None)


   .. py:method:: _interpolate_horizontal_layers(data, nearest=False)

      Interpolate all layers of 3d (or 2d) array.



   .. py:method:: _wrap_longitude(x)


   .. py:method:: covers_positions(x, y, z=None)

      Check if given positions are covered by this reader block.