astrohack.utils.gridding
========================

.. py:module:: astrohack.utils.gridding


Functions
---------

.. autoapisummary::

   astrohack.utils.gridding.grid_beam
   astrohack.utils.gridding.gridding_correction
   astrohack.utils.gridding.grid_1d_data


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

.. py:function:: grid_beam(ant_ddi_xdt: xarray.DataTree, grid_size, sky_cell_size, avg_chan, chan_tol_fac, telescope, grid_interpolation_mode, observation_summary, label)

   Grids the visibilities onto a 2D plane based on their Sky coordinates, using scipy griddata or a gaussian
   convolution
   :param ant_ddi_xdt: Xarray DataTree containing the visibilities
   :param grid_size: The size of the beam image grid (pixels)
   :param sky_cell_size: Size of the beam grid cell in the sky (radians)
   :param avg_chan: Average cahnnels? (boolean)
   :param chan_tol_fac: Frequency tolerance to chunk channels together
   :param telescope: Telescope object containing optical description of the telescope
   :param grid_interpolation_mode: linear, nearest, cubic or gaussian (convolution)
   :param observation_summary: Dictionaty containing a summary of observation information.
   :param label: label to be used in messages

   :returns: The gridded beam, its time centroid, frequency axis, polarization axis, L and M axes and a boolean about the
             necessity of gridding corrections after fourier transform.


.. py:function:: gridding_correction(aperture, freq, diameter, sky_cell_size, u_axis, v_axis)

   Execute gridding correction after fourier transform for the case of the gaussian convolution
   :param aperture: Aperture image
   :param freq: representative frequency
   :param diameter: Telescope diameter
   :param sky_cell_size: Size of the beam grid cell in the sky (radians)
   :param u_axis: U axis of the aperture grid
   :param v_axis: V axis of the aperture grid

   :returns: The gridding corrected aperture grid


.. py:function:: grid_1d_data(dest_ax, orig_ax, y_data, method, orig_label, dest_label, gaussian_fallback=True, return_weights=False, second_dim_len=2)