snsim.astrobj ============= .. py:module:: snsim.astrobj .. autoapi-nested-parse:: Contains transients models. Classes ------- .. autoapisummary:: snsim.astrobj.AstrObj snsim.astrobj.SNIa snsim.astrobj.TimeSeries snsim.astrobj.SNII snsim.astrobj.SNIIpl snsim.astrobj.SNIIb snsim.astrobj.SNIIn snsim.astrobj.SNIbc snsim.astrobj.SNIc snsim.astrobj.SNIb snsim.astrobj.SNIc_BL snsim.astrobj.SNIax snsim.astrobj.SNIa91bg Module Contents --------------- .. py:class:: AstrObj(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`abc.ABC` Basic class for transients. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:method:: gen_flux(obs, mod_fcov=False, seed=None) Generate the flux for given obs. :param obs: Observations info. :type obs: pd.DataFrame :param mod_fcov: Either or not using model scattering, by default False :type mod_fcov: bool, optional :param seed: numpy random seed, by default None :type seed: numpy.random.SeedSequence, optional :returns: Flux of the AstrObj for given obs. :rtype: pd.DataFrane :raises ValueError: Raises if mod_fcov is not available for the used model .. py:method:: mag_restframeband_to_amp(mag, band, magsys, amp_param_name='x0') .. py:property:: source .. py:property:: zpec Get peculiar velocity redshift. .. py:property:: zCMB Get CMB frame redshift. .. py:property:: zobs Get observed redshift. .. py:property:: mu Get distance moduli. .. py:property:: sim_model .. py:property:: sim_par .. py:class:: SNIa(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`AstrObj` SNIa class. Inherit from AstrObj. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:method:: SALTTripp(M0, alpha, beta, x1, c, coh_sct) :staticmethod: .. py:class:: TimeSeries(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`AstrObj` TimeSeries class. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNII(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`TimeSeries` SNII class. Inherit from TimeSeries. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIIpl(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`TimeSeries` SNII P/L class. Inherit from TimeSeries. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIIb(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`TimeSeries` SNIIb class. Inherit from TimeSeries. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIIn(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`TimeSeries` SNIIn class. Inherit from TimeSeries. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIbc(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`TimeSeries` SNIb/c class. Inherit from TimeSeries. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIc(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`TimeSeries` SNIIn class. Inherit from TimeSeries. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIb(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`TimeSeries` SNIIn class. Inherit from TimeSeries. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIc_BL(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`TimeSeries` SNIIn class. Inherit from TimeSeries. Init AstrObj class. :param sim_par: Simulation parameters. | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type sim_par: dict :param mag_fun: The function used to compute the abs mag, by default None :type mag_fun: str, optional :param effects: sncosmo effects dic, by default None | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type effects: list, optional :raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIax(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`AstrObj` SNiax class. :param sn_par: Parameters of the object. | same as BasicAstrObj parameters | └── mag_sct, coherent mag scattering. :type sn_par: dict :param sim_model: sncosmo Model to use. :type sim_model: sncosmo.Model :param model_par: General model parameters. | same as BasicAstrObj model_par | ├── M0, absolute magnitude | ├── sigM, sigma of coherent scattering | └── used model parameters :type model_par: dict :param Init AstrObj class.: :param : | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type : param sim_par: Simulation parameters. :param : :type : type sim_par: dict :param : :type : param mag_fun: The function used to compute the abs mag, by default None :param : :type : type mag_fun: str, optional :param : | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type : param effects: sncosmo effects dic, by default None :param : :type : type effects: list, optional :param : :type : raises ValueError: If simpar['model_name'] is not available .. py:class:: SNIa91bg(sim_par, mag_fun=None, effects=None) Bases: :py:obj:`AstrObj` SNia91bg class. :param sn_par: Parameters of the object. | same as BasicAstrObj parameters | └── mag_sct, coherent mag scattering. :type sn_par: dict :param sim_model: sncosmo Model to use. :type sim_model: sncosmo.Model :param model_par: General model parameters. | same as BasicAstrObj model_par | ├── M0, absolute magnitude | ├── sigM, sigma of coherent scattering | └── used model parameters :type model_par: dict :param Init AstrObj class.: :param : | sim_par | ├── zcos, cosmological redshift | ├── zpcmb, CMB dipole redshift contribution | ├── como_dist, comoving distance of the obj | ├── vpec, obj peculiar velocity | ├── ra, obj Right Ascension | ├── dec, obj Declinaison | ├── t0, obj peak time | └── sncosmo par :type : param sim_par: Simulation parameters. :param : :type : type sim_par: dict :param : :type : param mag_fun: The function used to compute the abs mag, by default None :param : :type : type mag_fun: str, optional :param : | effect | ├── source: sncosmo.effect, sncosmo effect obj | ├── frame: str 'obs' or 'rest' | └── name: str, effect name :type : param effects: sncosmo effects dic, by default None :param : :type : type effects: list, optional :param : :type : raises ValueError: If simpar['model_name'] is not available