shareloc.math_utils
===================

.. py:module:: shareloc.math_utils

.. autoapi-nested-parse::

   This module contains the mathematical functions for shareloc



Functions
---------

.. autoapisummary::

   shareloc.math_utils.inter
   shareloc.math_utils.interpol_bilin_grid
   shareloc.math_utils.interpol_bilin
   shareloc.math_utils.interpol_bilin_vectorized


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

.. py:function:: inter(mats, delta_shift_col, delta_shift_row, lower_shift_col, lower_shift_row)

   Shared computation part for interpolation

   :param mats: multi layer grid (: , nb_rows,nb_cols)
   :param delta_shift_col: position (columns)
   :param delta_shift_row: position (line)
   :param lower_shift_col: lower integer position (columns)
   :param lower_shift_row: lower integer position (line)


.. py:function:: interpol_bilin_grid(mats, nb_rows, nb_cols, delta_shift_row, delta_shift_col)

   bilinear interpolation on multi layer  matrix
   :param mats: multi layer grid (: , nb_rows,nb_cols)
   :type mats: list
   :param nb_rows: line number of mats
   :type nb_rows: int
   :param nb_cols: column number of mats
   :type nb_cols: int
   :param delta_shift_row: position (line)
   :type nb_cols: float
   :param delta_shift_col: position (column)
   :type nb_cols: float
   :return interpolated value on each layer
   :rtype list


.. py:function:: interpol_bilin(mat, nb_rows, nb_cols, delta_shift_row, delta_shift_col)

   bilinear interpolation on multi layer matrix
   :param mat: multi layer grid (nb_rows,nb_cols, :)
   :type mat: np.ndarray
   :param nb_rows: line number of mats
   :type nb_rows: int
   :param nb_cols: column number of mats
   :type nb_cols: int
   :param delta_shift_row: position (line)
   :type nb_cols: float
   :param delta_shift_col: position (column)
   :type nb_cols: float
   :return interpolated value on each layer
   :rtype: float


.. py:function:: interpol_bilin_vectorized(mats, nb_rows, nb_cols, delta_shift_row, delta_shift_col)

   bilinear interpolation on multi points and layer  matrix
   :param mats: multi layer grid (: , nb_rows,nb_cols)
   :type mats: list
   :param nb_rows: line number of mats
   :type nb_rows: int
   :param nb_cols: column number of mats
   :type nb_cols: int
   :param delta_shift_row: position (line)
   :type nb_cols: float
   :param delta_shift_col: position (column)
   :type nb_cols: float
   :return interpolated value on each layer
   :rtype list