credit.verification.standard
============================

.. py:module:: credit.verification.standard


Attributes
----------

.. autoapisummary::

   credit.verification.standard.logger


Functions
---------

.. autoapisummary::

   credit.verification.standard.average_zonal_spectrum
   credit.verification.standard.zonal_spectrum
   credit.verification.standard.average_div_rot_spectrum
   credit.verification.standard.div_rot_spectrum


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

.. py:data:: logger

.. py:function:: average_zonal_spectrum(da, grid, norm='ortho')

   takes the average of all spectra in da

   input: Torch Tensor with dim  (..., wavenumber)
   output: numpy array with dim (wavenumber)



.. py:function:: zonal_spectrum(da, grid, norm='ortho')

   Returns the zonal energy spectrum of a dataarray with dimensions

   input: DataArray with backing array with dim (..., lat, lon)
   output: Torch Tensor with dim  (..., nlat // 2 + 1)



.. py:function:: average_div_rot_spectrum(ds, grid, wave_spec='n', norm='ortho')

   takes the average of all divergence and rotational spectra in da

   input: Torch Tensor with dim  (..., n, m), total_wavenum x ...
   output: numpy array with dim (wavenumber)



.. py:function:: div_rot_spectrum(ds, grid, norm='ortho')

   Returns the spectrum of the divergent and rotational components of a flow

   input: Dataset with variables U,V each with backing array with dim (..., lat, lon)
   output: Torch Tensor with dim  (..., nlat // 2 + 1)