snews_cs.cs_stats
=================

.. py:module:: snews_cs.cs_stats


Functions
---------

.. autoapisummary::

   snews_cs.cs_stats.ncr
   snews_cs.cs_stats.cache_false_alarm_rate


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

.. py:function:: ncr(n, r)

.. py:function:: cache_false_alarm_rate(cache_sub_list, hb_cache)

   Assume false alarm rate of 1 per week
           returns the combined false alarm rate in years
           meaning; if there are 8 active detectors, each with false alarm rate of 1/week
           We would get a false alarm with 2-fold coincidence every X years
           The formula;
               n = number of detectors
               r = number of coincidences
               C(n,r) =
   rac{n!}{r!(n-r)!}

               R_{combined} = C(n,r)+1     imes F_{im, d1} * F_{im, d2} ... * F_{im, dn}   imes δt^{r-1}