:py:mod:`survey_analysis`
=========================

.. py:module:: survey_analysis

.. autoapi-nested-parse::

   This works on image files in FITS format. It is given the name of a FITS file,
   or a name with wild-cards (to be interpreted by glob.glob), or the name of
   a file containing a list of fits file names. The list file name should be prefixed with @.

   Outputs are written to the working directory; this is either the current directory, or the directory
   given with the -d option.

   Input file names must successfully address the input files from the working directory.

   Two kinds of output are produced:
   1. <workdir>/racs_stats_<run_date>.csv is created and statistics and PSF details are written to it.
   2. <workdir>/<image_file_name>.rms.fits is created; this is the rms image from which statistics are determined.
   -------------------------------------------------------------



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


Functions
~~~~~~~~~

.. autoapisummary::

   survey_analysis.arg_init
   survey_analysis.do_noise_statistics
   survey_analysis.filter
   survey_analysis.get_filtered_sources
   survey_analysis.do_bright_src_errs
   survey_analysis.write_b_err
   survey_analysis.write_stats
   survey_analysis.set_warn_filters
   survey_analysis.main



Attributes
~~~~~~~~~~

.. autoapisummary::

   survey_analysis.NOFORMAT
   survey_analysis.b_err_colnames
   survey_analysis.b_err_coltypes
   survey_analysis.b_err_types
   survey_analysis.stats_colnames
   survey_analysis.stats_coltypes
   survey_analysis.stats_types
   survey_analysis.explanation


.. py:data:: NOFORMAT
   :value: '{noformat}\n'

   

.. py:data:: b_err_colnames
   :value: ['RA_DEG', 'DEC_DEG', 'BR_MIN', 'BR_MAX']

   

.. py:data:: b_err_coltypes
   :value: ['f4', 'f4', 'f4', 'f4']

   

.. py:data:: b_err_types

   

.. py:data:: stats_colnames
   :value: ['FLD_NAME', 'SBID', 'MED_RMS_uJy', 'MODE_RMS_uJy', 'STD_RMS_uJy', 'MIN_RMS_uJy', 'MAX_RMS_uJy']

   

.. py:data:: stats_coltypes
   :value: ['S20', 'i4', 'f4', 'f4', 'f4', 'f4', 'f4']

   

.. py:data:: stats_types

   

.. py:data:: explanation

   

.. py:function:: arg_init()


.. py:function:: do_noise_statistics(in_files, survey, replace=False, fcor_stats=True, method='rms')


.. py:function:: filter(hsib, flux_peak)


.. py:function:: get_filtered_sources(beam_table)


.. py:function:: do_bright_src_errs(in_file, survey)


.. py:function:: write_b_err(db, fld, sb, data)


.. py:function:: write_stats(db, in_table)


.. py:function:: set_warn_filters()


.. py:function:: main()