#
# stub function definition file for docstring parsing
#
[docs]def importgmrt(fitsfile, flagfile='', vis=''):
r"""
Convert a UVFITS file to a CASA visibility data set
[`Description`_] [`Examples`_] [`Development`_] [`Details`_]
Parameters
- fitsfile_ (path) - Name of input UV FITS file
- flagfile_ ({string, stringVec}='') - List of files containing flagging information.
- vis_ (string='') - Name of input visibility file
.. _Description:
Description
Converts a FITS file with visibility data from the Giant Metrewave
Radio Telescope (GMRT) into a CASA MeasurementSet (MS).
GMRT flag files can also be read and applied using the *flagfile*
parameter.
.. _Examples:
Examples
The following example shows how visibility data from the GMRT that
is stored in a FITS file can be imported into CASA:
::
importgmrt(fitsfile='fitsfile.fits', flagfile=['gmrt_flagfile1.flag','gmrt_flagfile2.flag'], vis='outputvis.ms')
This imports GMRT visibilities from FITS file *'* fitsfile.fits',
applies flagging that is captured in the two flag files
'gmrt_flagfile1.flag' and 'gmrt_flagfile2.flag', and writes out
the unflagged visibilites in MeasurementSet 'outputvis.ms'.
.. note:: Don't forget to manually flag autocorrections using
**flagdata** with *autocorr = True*
.. _Development:
Development
No additional development details
.. _Details:
Parameter Details
Detailed descriptions of each function parameter
.. _fitsfile:
| ``fitsfile (path)`` - Name of input UV FITS file
| Default: none
| Example: fitsimage='3C273XC1.fits'
.. _flagfile:
| ``flagfile ({string, stringVec}='')`` - List of files containing flagging information.
| Default: none
| Examples:
| flagfile='3c273XC1.flag'
| flagfile=['3c273Cc1_1.flag','3c273Cc2_1.flag',']
.. _vis:
| ``vis (string='')`` - Name of input visibility file
| Default: none
| Example: vis='ngc5921.ms'
"""
pass