snsim.scatter
=============

.. py:module:: snsim.scatter

.. autoapi-nested-parse::

   This package contains the scattering effects.



Classes
-------

.. autoapisummary::

   snsim.scatter.G10
   snsim.scatter.C11


Functions
---------

.. autoapisummary::

   snsim.scatter.init_sn_sct_model
   snsim.scatter.gen_BS20_scatter


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

.. py:function:: init_sn_sct_model(sct_mod, *args)

   Add scattering effect on sncosmo model.

   :param sct_mod: Name of the model to use.
   :type sct_mod: str

   :rtype: None


.. py:class:: G10(SALTsource)

   Bases: :py:obj:`sncosmo.PropagationEffect`


   Guy (2010) SNe Ia non-coherent scattering.

   Implementation is done following arxiv:1209.2482.

   Initialize G10 class.


   .. py:attribute:: param_names_latex
      :value: ['\\lambda_0', 'F_0', 'F_1', 'd_L', 'RndS']



   .. py:method:: compute_sigma_nodes()

      Computes the sigma nodes.



   .. py:method:: propagate(wave, flux)

      Propagate the effect to the flux.



.. py:class:: C11

   Bases: :py:obj:`sncosmo.PropagationEffect`


   C11 scattering effect for sncosmo.
   Use COV matrix between the vUBVRI bands from N. Chottard thesis.
       Implementation is done following arxiv:1209.2482.

   Initialise C11 class.


   .. py:attribute:: param_names_latex
      :value: ['\rho_\\mathrm{vU}', 'S_f', 'RndS']



   .. py:method:: build_cov()


   .. py:method:: propagate(wave, flux)

      Propagate the effect to the flux.



.. py:function:: gen_BS20_scatter(n_sn, par_names=['beta_sn', 'Rv', 'E_dust', 'c_int'], seed=None)

   Generate n coherent mag scattering term.

   :param n: Number of mag scattering terms to generate.
   :type n: int
   :param seed: Random seed.
   :type seed: int, optional

   :returns: numpy array containing scattering terms generated.
   :rtype: numpy.ndarray(float)