:py:mod:`raytracing_utils`
==========================

.. py:module:: raytracing_utils

.. autoapi-nested-parse::

   Module containing catalog-agnostic raytracing utility functions



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


Functions
~~~~~~~~~

.. autoapisummary::

   raytracing_utils.approx_mean_kappa
   raytracing_utils.fit_gp



.. py:function:: approx_mean_kappa(fit_model, weighted_mass_sum, seed)

   Approximate the mean kappa given the log weighted sum of halo masses

   Parameters
   ----------
   fit_model : object
       any model that has a method `predict` returning the mean and standard
       deviation of predictions as a tuple, given the input X (first argument)
       and a boolean `return_std` option set to True
   weighted_mass_sum : np.array
       log10(sum over halo masses weighted by the lensing efficiency Dds/Ds),
       where halo masses are in solar masses

   Returns
   -------
   np.array
       the simulated mean kappa, including spread, of the halos



.. py:function:: fit_gp(train_X, train_Y)

   Fit a Gaussian process regressor