#
# stub function definition file for docstring parsing
#
[docs]def defintent(vis, intent='', mode='', outputvis='', scan='', field='', obsid=''):
r"""
Manually set scan intents
[`Description`_] [`Examples`_] [`Development`_] [`Details`_]
Parameters
- vis_ (path) - Name of input visibility file (MS)
- intent_ (string='') - String to add to intents
- mode_ (string='') - Set mode
- outputvis_ (string='') - Makes a copy of the ms to edit
- scan_ (string='') - Select Scan
- field_ (string='') - Select field using field id(s) or field name(s)
- obsid_ (string='') - Select ObsId
.. _Description:
Description
Allows users to manually set or append to the intents in the MS. Several selection parameters can
be used to target which intents to change including scan, field, and ObsId. Users will be able to
add either brand new intents, or a new intent appended to existing intent value(s).
.. warning:: **WARNING**: This task will allow the user to specify any string to add to the
intents without enforcing any specific list of allowed intents.
.. rubric:: Parameters
*vis*
Specify the name of the MS as a string
*intent*
Specify the name(s) of intents to replace or append to the selected data
*mode*
mode ‘set’ will replace the selected data with the provided intents; mode ‘append’ will add the new intent selection to the existing selected data intents
*outputvis*
Set the name of the modified MS that will be created by the task. If outputvis is equal to vis then the provided vis will be modified and a copy will not be made.
*field*
Select on MS fields. The default selection of '' is all fields
*scan*
Select on MS scans. The default selection of '' is all scans
*obsid*
Select on observation ids. The default selection of '' is all obs ids
.. _Examples:
Examples
This will replace the intents of the MS where scan is between 0 and 3, field is 0, and obsid with the new intent of 'AMPLI'. The vis will be copied and the output with the modified intents will be called outputcopy.ms:
::
defintent(vis='gaincaltest2.ms', intent='AMPLI', mode='set',
outputvis='outputcopy.ms', scan='0~3', field='0', obsid='0')
.. _Development:
Development
No additional development details
.. _Details:
Parameter Details
Detailed descriptions of each function parameter
.. _vis:
| ``vis (path)`` - Name of input visibility file (MS)
| Default: none
| Example: vis='ngc5921.ms'
.. _intent:
| ``intent (string='')`` - select intent to add
.. _mode:
| ``mode (string='')`` - Intent modification mode (set/append)
.. _outputvis:
| ``outputvis (string='')`` - Creates an output ms with all the changes from the task leaving the original vis untouched.
.. _scan:
| ``scan (string='')`` - Select Scan to apply the new intents to
.. _field:
| ``field (string='')`` - Select field using field id(s) or field name(s)
.. _obsid:
| ``obsid (string='')`` - Select ObsId
"""
pass