:py:mod:`gnome.utilities.surface_concentration`
===============================================

.. py:module:: gnome.utilities.surface_concentration

.. autoapi-nested-parse::

   Code to compute surface surface_concentration from particles

   Ultimatley, there may be multiple versions of this
   -- with Cython optimizationas and all that.



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


Functions
~~~~~~~~~

.. autoapisummary::

   gnome.utilities.surface_concentration.compute_surface_concentration
   gnome.utilities.surface_concentration.surface_conc_kde



.. py:function:: compute_surface_concentration(sc, algorithm)

   compute the surface concentration from the passed-in spill container

   :param sc: spill container -- data in it wil be usd, and the results will
              be put in a "surface_concentration" array

   :param algorithm: algorithm to use -- currently only "kde" is supported


.. py:function:: surface_conc_kde(sc)

   Computes the surface concentration using scipy's

   Kernel Density Estimator code



   a "surface_concentration" array will be added to the spill container

   :param sc: spill container that you want the concentrations computed on