#
# stub function definition file for docstring parsing
#
[docs]
def appendantab(vis, outvis, antab, overwrite=False, append_tsys=True, append_gc=True):
r"""
Append syscal and gaincurve data from an antab file
[`Description`_] [`Examples`_] [`Development`_] [`Details`_]
Parameters
- vis_ (path) - Name of input visibility file
- outvis_ (string) - Name of output visibility file
- antab_ (path) - Name of the input antab file
- overwrite_ (bool=False) - Allow overwrite of outvis
- append_tsys_ (bool=True) - Append the SYSCAL subtable
- append_gc_ (bool=True) - Append the GAIN_CURVE subtable
.. _Description:
Allow users to append information available in antab files directly to a ms.
Use a ms generated from importfitsidi and then use this task to append tsys and gain curve information
to the ms.
.. warning:: **WARNING**: The parser for the antab files can be quite strict which may effect some instruments disproportionately. If you had success with the vlbi tools version this parser is the same. This task also MUST be used with importfitsidi filled data. It is also recommended that, if using an ms generated from multiple fitsidi files, constobsid should be set to True if the resulting ms will be used in conjunction with this task.
.. rubric:: Parameters
*vis*
Specify the name of the MS created from a fits file as a string
*outvis*
Specify the name of the output vis that will have the antab information appended to it
*antab*
Specify the antab file to be appended to the vis as a string
*overwrite*
If True then the task will overwrite existing values in the GAIN_CURVE and SYSCAL tables if overlapping data is present in the antab file. Data in the antab file that does not overlap with a value in existing tables will be appended as normal.
*append_tsys*
Using the tsys information available in the antab file append to the SYSCAL subtable when this is True
*append_gc*
Using the gain curve information available in the antab file append to the GAIN_CURVE subtable when this is True
.. _Examples:
Examples
This example will take a ms and output one with the name "appended_data.ms" by appending the tys and gc infromation from an antab file:
::
appendantab(vis='imported_fits.ms', outvis='appended_data.ms, overwrite=False,
append_tsys=True, append_gc=True)
.. _Development:
Development
No additional development details
.. _Details:
Parameter Details
Detailed descriptions of each function parameter
.. _vis:
| ``vis (path)`` - Name of input visibility file
| Default: none
| Example: vis='ngc5921.ms'
.. _outvis:
| ``outvis (string)`` - Name of output visibility file. If the file name specified already exists it will be replaced
| Default: none
| Example: caltable='ngc5921.ms'
.. _antab:
| ``antab (path)`` - Name of antab file to append info from
| Default: none
| Example: caltable='bc246b.antab'
.. _overwrite:
| ``overwrite (bool=False)`` - Allows the outvis file to be overwritten
| Default: False
.. _append_tsys:
| ``append_tsys (bool=True)`` - Use the information from the antab file to create and fill the SYSCAL subtable
| Default: True
.. _append_gc:
| ``append_gc (bool=True)`` - Use the information from the antab file to create and fill the GAIN_CURVE subtable
| Default: True
"""
pass