wavy.grid_stats
===============

.. py:module:: wavy.grid_stats


Functions
---------

.. autoapisummary::

   wavy.grid_stats.grid_mean
   wavy.grid_stats.grid_mean_group
   wavy.grid_stats.grid_stats_group
   wavy.grid_stats.grid_rmse
   wavy.grid_stats.apply_metric


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

.. py:function:: grid_mean(gco, **kwargs)

   purpose: computes gridded means
   arguments:
       Midx -> index matrix Midx[0]: indices for grid longitude
                                     indices for grid latitude
       glons -> grid longitude
       glats -> grid latitude
       ovals -> observation values

   returns:
       var_grid -> gridded variable
       lon_grid -> longitude grid
       lat_grid -> latitude grid


.. py:function:: grid_mean_group(gco, **kwargs)

   purpose: computes gridded means with group strategy
   arguments:
       Midx -> index matrix Midx[0]: indices for grid longitude
                                     indices for grid latitude
       glons -> grid longitude
       glats -> grid latitude
       ovals -> observation values

   returns:
       var_grid -> gridded variable
       lon_grid -> longitude grid
       lat_grid -> latitude grid


.. py:function:: grid_stats_group(gco, **kwargs)

   purpose: computes gridded rmse with group strategy
   arguments:
       Midx -> index matrix Midx[0]: indices for grid longitude
                                     indices for grid latitude
       glons -> grid longitude
       glats -> grid latitude
       ovals -> observation values
       mvals -> model values

   returns:
       var_grid -> gridded variable
       lon_grid -> longitude grid
       lat_grid -> latitude grid


.. py:function:: grid_rmse(gco, **kwargs)

   purpose: computes gridded rmse
   arguments:
       Midx -> index matrix Midx[0]: indices for grid longitude
                                     indices for grid latitude
       glons -> grid longitude
       glats -> grid latitude
       ovals -> observation values
       mvals -> model values

   returns:
       var_grid -> gridded variable
       lon_grid -> longitude grid
       lat_grid -> latitude grid


.. py:function:: apply_metric(gco=None, **kwargs)

   dispatch table for various validation metrics