gwkokab.analysis.core.discrete_base
===================================

.. py:module:: gwkokab.analysis.core.discrete_base


Classes
-------

.. autoapisummary::

   gwkokab.analysis.core.discrete_base.DiscreteBase


Functions
---------

.. autoapisummary::

   gwkokab.analysis.core.discrete_base.discrete_arg_parser


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

.. py:class:: DiscreteBase(likelihood_fn: collections.abc.Callable[Ellipsis, collections.abc.Callable[Ellipsis, jaxtyping.Array]], model: Union[numpyro.distributions.Distribution, collections.abc.Callable[Ellipsis, numpyro.distributions.Distribution]], where_fns: Optional[List[collections.abc.Callable[Ellipsis, jaxtyping.Array]]], data_loader: gwkokab.analysis.core.inference_io.DiscretePELoader, prior_filename: str, poisson_mean_filename: str, sampler_cfg, variance_cut_threshold: float | None, n_buckets: Optional[int], threshold: float, debug_nans: bool = False, profile_memory: bool = False, check_leaks: bool = False, analysis_name: str = '')

   Bases: :py:obj:`gwkokab.analysis.core.analysis_base.AnalysisBase`


   AnalysisBase is a class which contains all the common functionality among the
   different analyses.

   It is not meant to be used directly, but rather to be subclassed by the specific
   analyses.


   .. py:method:: read_data() -> Tuple[Tuple[jaxtyping.Array, Ellipsis], Tuple[jaxtyping.Array, Ellipsis], Tuple[jaxtyping.Array, Ellipsis]]


   .. py:method:: run() -> None


   .. py:attribute:: data_loader


   .. py:attribute:: likelihood_fn


   .. py:attribute:: n_buckets


   .. py:attribute:: threshold


   .. py:attribute:: where_fns


.. py:function:: discrete_arg_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser

   Populate the command line argument parser with the arguments for the discrete
   analyses.