snsim.plot_utils
================

.. py:module:: snsim.plot_utils

.. autoapi-nested-parse::

   Contains plot functions.



Functions
---------

.. autoapisummary::

   snsim.plot_utils.param_text_box
   snsim.plot_utils.plot_lc
   snsim.plot_utils.plot_ra_dec


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

.. py:function:: param_text_box(text_ax, model_name, sim_par=None, fit_par=None, pos=[0.01, 0.4])

   Add a text legend with model parameters to the plot.

   :param text_ax: Axes where place the text.
   :type text_ax: matplotlib.axes
   :param model_name: The name of the sn model that is used.
   :type model_name: str
   :param sim_par: The parameters of the model.
   :type sim_par: list(float)
   :param fit_par: The fitted parameters and errors.
   :type fit_par: list(tuple(float,float))


.. py:function:: plot_lc(flux_table, meta, zp=25.0, mag=False, Jy=False, snc_sim_model=None, snc_fit_model=None, fit_cov=None, residuals=False, bandcol=None, set_main=None, set_res=None, flux_limit=None, phase_limit=[-21, 51], mtpstyle='seaborn-v0_8-deep', dpi=100, savefig=False, savepath='LC', saveformat='png')

   Ploting a lightcurve flux table.

   :param flux_table: The lightcurve to plot.
   :type flux_table: pandas.Series
   :param meta: The lightcurve meta data.
   :type meta: dict.
   :param zp: Zeropoint at which rescale the flux.
   :type zp: float, default = 25.
   :param mag: If True plot the magnitude.
   :type mag: bool
   :param Jy: If True plot the flux in Jansky.
   :type Jy: bool
   :param snc_sim_model: Model used to simulate the lightcurve.
   :type snc_sim_model: sncosmo.Model
   :param snc_fit_model: Model used to fit the lightcurve.
   :type snc_fit_model: sncosmo.Model
   :param fit_cov: sncosmo t0, x0, x1, c covariance matrix from SALT fit.
   :type fit_cov: numpy.ndarray(float, size=(4, 4))
   :param residuals: If True plot fit residuals.
   :type residuals: bool
   :param bandcol: Give the color to use for each band.
   :type bandcol: dict
   :param set_main: Pass matplotlib options as ax.set(**set_main).
   :type set_main: dict
   :param set_res: Same as pass main but for the residuals axis.
   :type set_res: dict
   :param mtpstyle: The matplotlib style to use.
   :type mtpstyle: str
   :param dpi: The dpi to use.
   :type dpi: int
   :param savefig: If true save the figure rather than plot.
   :type savefig: bool
   :param savepath: The path to save the figure.
   :type savepath: str
   :param saveformat: Format to use ex : png, pdf.
   :type saveformat: str


.. py:function:: plot_ra_dec(ra, dec, vpec=None, field_list=None, field_dic=None, field_size=None, **kwarg)

   Plot a mollweide map of ra, dec.

   :param ra: Right Ascension.
   :type ra: list(float)
   :param dec: Declinaison.
   :type dec: type
   :param vpec: Peculiar velocities.
   :type vpec: type

   :returns: Just plot the map.
   :rtype: None