:py:mod:`aces.survey.survey_class`
==================================

.. py:module:: aces.survey.survey_class


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

Classes
~~~~~~~

.. autoapisummary::

   aces.survey.survey_class.ASKAP_Survey
   aces.survey.survey_class.SurveyFiles



Functions
~~~~~~~~~

.. autoapisummary::

   aces.survey.survey_class.t_string
   aces.survey.survey_class.no_translate
   aces.survey.survey_class.make_beam_csv_name
   aces.survey.survey_class.make_brt_err_csv_name
   aces.survey.survey_class.make_astrom_bb_csv_name
   aces.survey.survey_class.make_cat_match_csv_name
   aces.survey.survey_class.make_leakage_csv_name
   aces.survey.survey_class.make_statistics_name
   aces.survey.survey_class.make_fits_name
   aces.survey.survey_class.parse_filename
   aces.survey.survey_class.access_db
   aces.survey.survey_class.release_db
   aces.survey.survey_class.ASKAP_Survey_factory



Attributes
~~~~~~~~~~

.. autoapisummary::

   aces.survey.survey_class.field_name
   aces.survey.survey_class.image_stats_name


.. py:data:: field_name
   :value: 'field_data.csv'

   

.. py:data:: image_stats_name
   :value: 'image_statistics.csv'

   

.. py:function:: t_string(db_time)


.. py:function:: no_translate(a)


.. py:function:: make_beam_csv_name(sbid, field)


.. py:function:: make_brt_err_csv_name(sbid, field)


.. py:function:: make_astrom_bb_csv_name(sbid, field)


.. py:function:: make_cat_match_csv_name(sbid, field, tag)


.. py:function:: make_leakage_csv_name(sbid, field, pol)


.. py:function:: make_statistics_name(sbid, field)


.. py:function:: make_fits_name(sbid, field)


.. py:function:: parse_filename(file_name)


.. py:function:: access_db(t=0, wd=Path('.'), tmax=10)


.. py:function:: release_db(wd=Path('.'), content=' ')


.. py:function:: ASKAP_Survey_factory(epoch=0, read_write=False, verbose=False)

   :param epoch: Integer epoch number. An exception is raised if the description table lack a row for this epoch.



.. py:class:: ASKAP_Survey(field_table, description)

   Bases: :py:obj:`object`

   .. py:method:: __len__()


   .. py:method:: _select(criteria)

      Return a table selected by the criteria
      :param criteria: List of three-element criteria. Items of the list combined with AND

      eg: critera = [['COL1', '==', 21], ['COL2', '>', 1.4]]


   .. py:method:: select_indices(criteria)

      Return a table selected by the criteria
      :param criteria: List of three-element criteria. Items of the list combined with AND


   .. py:method:: select(criteria)

      Return a table selected by the criteria
      :param criteria: List of three-element criteria. Items of the list combined with AND


   .. py:method:: set_select()


   .. py:method:: get_sbs_cal()


   .. py:method:: get_sbs_sci(calsb)


   .. py:method:: get_sbids()


   .. py:method:: get_fields(sbid)


   .. py:method:: get_nfields(sbid)


   .. py:method:: find_field(field_name, translate=no_translate)

      Return the indices of rows with FIELD_NAME match with input. Several may be returned
      if the one field were observed more than once.
      :param field_name:
      :return: list of indices.


   .. py:method:: find_position(ra, dec)


   .. py:method:: get_column(col)


   .. py:method:: get_row(inx)


   .. py:method:: get_field_data(inx, cols)


   .. py:method:: put_field_data(inx, cols, data)

      Over-write values in the field data table
      :param inx: row number of table
      :param cols: Names of columns to receive new values
      :param data: List of values. Length must match length of cols list.


   .. py:method:: get_field_table()

      Return the field table as an astropy Table
      :return: (Table) field_table


   .. py:method:: get_sub_table(fld, sbid, which, **kw)

      :param fld:
      :param sbid:
      :param which: Select which table from 'beam', 'cat', 'ast_bb', 'statistics'
      :returns astropy Table


   .. py:method:: get_sub_fitsdata(fld, sbid, which)

      :param fld:
      :param sbid:
      :param which: Select which file from 'bpa', 'bmi', 'bpa'
      :returns ndarray image


   .. py:method:: get_inx_from_fld_sbid(fld, sbid)


   .. py:method:: get_row_from_prod_name(pname)


   .. py:method:: sort_field_data(cols)

      :param cols: List of column names


   .. py:method:: get_data_root()


   .. py:method:: get_freq_ref()


   .. py:method:: show_one(inx)


   .. py:method:: write_field_table()


   .. py:method:: release()



.. py:class:: SurveyFiles(survey, file_templates)

   Bases: :py:obj:`object`

   .. py:method:: file_name(ftype, inx, taylor=0, stokes='i', beam=0)


   .. py:method:: cal_table_name(ftype, cal_sbid)

      Name of bandpass calibration tables.

      :param ftype: str, bp_table or bp_leakage_table.
      :param cal_sbid: int, SB ID of calibrator scan.
      :return: PosixPath to calibration table of choice.