snsim.tests.test_generators
===========================

.. py:module:: snsim.tests.test_generators


Attributes
----------

.. autoapisummary::

   snsim.tests.test_generators.FlatSource


Classes
-------

.. autoapisummary::

   snsim.tests.test_generators.FakeGen
   snsim.tests.test_generators.TestGenerators


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

.. py:data:: FlatSource

.. py:class:: FakeGen(params, cosmology, time_range, z_range=None, vpec_dist=None, hosts=None, mw_dust=None, cmb=None, geometry=None)

   Bases: :py:obj:`snsim.generators.BaseGen`


   Abstract class for basic astrobj generator.

   Init BaseGen class.

   :param params: Basic generator configuration.
   :type params: dict
   :param cosmology: The cosmological model to use.
   :type cosmology: astropy.cosmology
   :param time_range: (tmin, tmax) time range.
   :type time_range: tuple
   :param z_range: (zmin, zmax) redshift range,
                   no need to be defined if there is hosts, by default None
   :type z_range: tuple, optional
   :param vpec_dist: PV distrib parameters, by default None

                     | vpec_dist
                     | ├── mean_vpec, by default 0.
                     | └── sig_vpec, by default 0.
   :type vpec_dist: dic, optional
   :param hosts: hosts for simulated SN, by default None
   :type hosts: snsim.SnHost, optional
   :param mw_dust: Milky Way dust, by default None
   :type mw_dust: dic, optional
   :param cmb: CMB dipole parameters, by default None

               | cmb
               | ├── v_cmb, by default 369.82 km/s
               | ├── l_cmb, by default 264.021 deg
               | └── b_cmb, by default 48.253 deg
   :type cmb: dic, optional
   :param geometry: The survey footprint, by default None
   :type geometry: shapely.geometry, optional

   :raises ValueError: If you set PV dist and hosts at the same time.
   :raises ValueError: If you neither set PV or hosts.
   :raises ValueError: If no hosts and no z_range.


   .. py:method:: gen_par(n_obj, basic_par, seed=None)

      Abstract method to add random generated parameters
      specific to the astro object used, called in __call__

      :param basic_par: Contains basic random generated properties.
      :type basic_par: dict(key: np.ndarray())
      :param seed: Random seed.
      :type seed: int or numpy.random.SeedSequence, optional



.. py:class:: TestGenerators

   .. py:method:: setup_class()


   .. py:method:: test_rate()


   .. py:method:: test_zcdf()