:py:mod:`profiley.helpers.lensing`
==================================

.. py:module:: profiley.helpers.lensing


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

Classes
~~~~~~~

.. autoapisummary::

   profiley.helpers.lensing.Lens
   profiley.helpers.lensing.Source




.. py:class:: Lens(z, cosmo=Planck15, frame='comoving', **kwargs)


   Bases: :py:obj:`profiley.helpers.cosmology.BaseCosmo`

   Lens object class

   Parameters
   ----------
   z : float or np.ndarray
       redshift

   Optional parameters
   -------------------
   cosmo : astropy.cosmology.FLRW object (default ``Planck15``)
       cosmology
   frame : str
       comoving or physical frame for distances
   kwargs : dict
       additional arguments passed to ``BaseCosmo``

   .. py:property:: chi

      Comoving distance to ``self``


   .. py:property:: Dl

      Angular diameter distance from the observer to ``self``


   .. py:method:: Dls(z_s)

      Angular diameter distance from ``self`` to a source at redshift ``z_s``


   .. py:method:: Dls_over_Ds(z_s)

      max(0, Dls/Ds)


   .. py:method:: sigma_crit(z_s=None)

      Critical surface density for a source at redshift ``z_s``


   .. py:method:: convergence(R, z_s=None, Roff=None, **kwargs)


   .. py:method:: offset_convergence(R, Roff, z_s=None, **kwargs)


   .. py:method:: lensing_kernel(z_s)

      Lensing kernel for a source at redshift ``z_s``



.. py:class:: Source(z_s, cosmo=Planck15)


   Bases: :py:obj:`profiley.helpers.cosmology.BaseCosmo`

   Lensed source class

   Parameters
   ----------
   z_s : float or np.ndarray
       source redshift

   Optional parameters
   -------------------
   cosmo : astropy.cosmology.FLRW object
       cosmology

   .. py:property:: chi

      Comoving distance to ``self``


   .. py:property:: Ds

      Angular diameter distance from the observer to ``self``


   .. py:method:: Dls(z_lens)

      Angular diameter distance from a lens at redshift ``z_lens`` to ``self``


   .. py:method:: sigma_crit(z_lens, frame='comoving')

      Critical surface density for a lens at redshift ``z_lens``


   .. py:method:: lensing_kernel(z_lens)

      Lensing kernel for a lens at redshift ``z_lens``