snsim.survey
============

.. py:module:: snsim.survey

.. autoapi-nested-parse::

   This module contains the class which are used in the simulation.



Classes
-------

.. autoapisummary::

   snsim.survey.SurveyObs


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

.. py:class:: SurveyObs(survey_config)

   This class deals with the observations of the survey.

   :param survey_config: It contains all the survey configuration.
   :type survey_config: dic
   :param | survey_config:
   :param | ├── survey_file PATH TO SURVEY FILE:
   :param | ├── ra_size RA FIELD SIZE IN DEG -> float:
   :param | ├── dec_size DEC FIELD SIZE IN DEG -> float:
   :param | ├── gain CCD GAIN e-/ADU -> float:
   :param | ├── start_day STARTING DAY -> float or str:
   :param opt:
   :param | ├── end_day ENDING DAY -> float or str:
   :param opt:
   :param | ├── duration SURVEY DURATION -> float:
   :param opt:
   :param | ├── zp FIXED ZEROPOINT -> float:
   :param opt:
   :param | ├── survey_cut:
   :param CUT ON OBS FILE -> dict:
   :param opt:
   :param | ├── add_data:
   :param LIST OF KEY TO ADD METADATA -> list(str):
   :param opt:
   :param | ├── field_map:
   :param PATH TO SUBFIELD MAP FILE -> str:
   :param opt:
   :param | └── sub_field:
   :param SUBFIELD KEY -> str:
   :param opt:
   :param Initialize SurveyObs class.:


   .. py:method:: get_observations(params, phase_cut=None, nep_cut=None, IDmin=0, use_dask=False, npartitions=None)

      Give the epochs of observations of a given SN.

      :param ra: Obj ra coord [rad].
      :type ra: numpy.ndarray(float) or float
      :param dec: Obj dec coord [rad].
      :type dec: numpy.ndarray(float) or float
      :param t0: Obj sncosmo model peak time.
      :type t0: numpy.ndarray(float) or float
      :param MinT: Obj sncosmo model mintime.
      :type MinT: numpy.ndarray(float) or float
      :param MaxT: Obj sncosmo model maxtime.
      :type MaxT: numpy.ndarray(float) or float
      :param nep_cut: The cut [nep, mintime, maxtime, band].
      :type nep_cut: list(list(int, float, float, str)), opt
      :param IDmin: ID of the first object.
      :type IDmin: int, opt

      :returns: pandas dataframe containing the observations.
      :rtype: pandas.DataFrame()



   .. py:method:: show_map(ax=None)

      Plot a representation of subfields.



   .. py:property:: config

      Survey configuration.


   .. py:property:: band_dic

      band_sncosmo.

      :type: Get the dic band_survey


   .. py:property:: obs_table

      Table of the observations.


   .. py:property:: gain

      Get CCD gain in e-/ADU.


   .. py:property:: zp

      Get zero point and it's uncertainty.


   .. py:property:: fwhm_psf

      Get PSF width.


   .. py:property:: duration

      Get the survey duration in days.


   .. py:property:: start_end_days

      Get the survey start and ending days.


   .. py:property:: field_size_rad

      Get field size ra, dec in radians.