defintent

defintent(vis, intent='', mode='', outputvis='', scan='', field='', obsid='')[source]

Manually set scan intents

[Description] [Examples] [Development] [Details]

Parameters

  • vis (path) - Name of input visibility file (MS)

  • intent (string=’’) - list of intent strings 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

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.

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. A new intent will be added that matches the input intent parameter name

mode ‘append’ will replace the intent of the selected data with a new intent that is the provided intent parameter appended to the old intents for that data selection. i.e. if the data previously had the intent ‘OBSERVE_TARGET#ON_SOURCE’ and mode append was used with intent=’NEW_INTENT’ the new intent for the data selection would be: ‘OBSERVE_TARGET#ON_SOURCE,NEW_INTENT’

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

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')

An append case with a string of multiple intents would look like this:

defintent(vis='twhya.short.ms',intent='OBSERVE_TARGET#ON_SOURCE,AMPLI,PHASE',mode='append',
   outputvis='twhya_out_append.ms',scan='',field='0',obsid='' )

The expected format of the intent string with multiple intents is a string with the seperate intents deliniated only by a comma

Development

No additional development details

Parameter Details

Detailed descriptions of each function parameter

vis (path) - Name of input visibility file (MS)
Default: none
Example: vis=’ngc5921.ms’
intent (string='') - select intent to add
The list of strings will be combined into an intent string to be added
mode (string='') - Intent modification mode (set/append)
outputvis (string='') - Creates an output ms with all the changes from the task leaving the original vis untouched.
scan (string='') - Select Scan to apply the new intents to
field (string='') - Select field using field id(s) or field name(s)
obsid (string='') - Select ObsId