Commits

Ville Suoranta authored 9b1faf67f13
Fix outputvis example of the fixvis task CAS-10567

gcwrap/tasks/fixvis.xml

Modified
17 17
18 18 <input>
19 19 <param type="string" name="vis" kind="ms" mustexist="true">
20 20 <description>Name of the input visibility set.</description>
21 21 <value></value>
22 22 <example>vis='ngc5921.ms'</example>
23 23 </param>
24 24 <param type="string" name="outputvis" kind="ms">
25 25 <description>Name of the output visibility set. (Can be the same as vis.)</description>
26 26 <value></value>
27 - <example>vis='ngc5921\_fixedvis.ms'</example>
27 + <example>vis='ngc5921fixedvis.ms'</example>
28 28 </param>
29 29 <param type="any" direction="in" name="field">
30 30 <description>Fields to operate on. '' = all.</description>
31 31 <any type="variant"/>
32 32 <value>""</value>
33 33 </param>
34 34 <!-- <param type="any" direction="in" name="observation">
35 35 <description>Observation ID(s) to operate on. '' = all.</description>
36 36 <any type="string int"/>
37 37 <value type="string"></value>
55 55 </param>
56 56 <param type="string" name="datacolumn">
57 57 <description>when applying a phase center shift, modify visibilities only in this/these column(s)</description>
58 58 <value>all</value>
59 59 </param>
60 60
61 61 </input>
62 62
63 63 <example>
64 64
65 -If the phase center is changed, the corresponding modifications are applied to the
66 -visibility columns given by the parameter "datacolumn" which is by default set
65 +If the phase center is changed, the corresponding modifications are applied to the
66 +visibility columns given by the parameter "datacolumn" which is by default set
67 67 to "all" (DATA, CORRECTED, and MODEL).
68 68
69 69 Input Parameters
70 70 vis -- Name of the input visibility set
71 -
71 +
72 72 outputvis -- Name of the output visibility set, default: same as vis
73 73
74 74 field -- field selection string
75 75
76 - refcode -- Reference frame to convert to, default: the refcode of PHASE_DIR in the
76 + refcode -- Reference frame to convert to, default: the refcode of PHASE_DIR in the
77 77 FIELD table
78 78 example: 'B1950'
79 -
79 +
80 80 reuse -- base recalculation on existing UVW coordinates? default=True
81 81 ignored if parameter 'phasecenter' is set
82 82
83 - phasecenter -- if set to a valid direction: change the phase center for the given
83 + phasecenter -- if set to a valid direction: change the phase center for the given
84 84 field to this value
85 85 example: 'J2000 9h25m00s -05d12m00s'
86 86 If given without the equinox, e.g. '0h01m00s +00d12m00s', the parameter
87 - is interpreted as a pair of offsets in RA and DEC to the present
88 - phasecenter.
89 - NOTE: The RA offset can be given in units of time or angle. If given
87 + is interpreted as a pair of offsets in RA and DEC to the present
88 + phasecenter.
89 + NOTE: The RA offset can be given in units of time or angle. If given
90 90 as a time (i.e. as a single number with a time unit as in, e.g., 12s
91 - or in the XXhXXmXXs or XX:XX:XX.XXX formats), it is applied as is.
92 - If given as an angle (e.g., 0.01deg), it is divided by the cos(DEC)
91 + or in the XXhXXmXXs or XX:XX:XX.XXX formats), it is applied as is.
92 + If given as an angle (e.g., 0.01deg), it is divided by the cos(DEC)
93 93 before it is applied.
94 94
95 95 distances -- (experimental) List of the distances (as quanta) of the fields selected by field
96 96 to be used for refocussing.
97 97 If empty, the distances of all fields are assumed to be infinity.
98 98 If not a list but just a single value is given, this is applied to
99 99 all fields.
100 100 default: []
101 101 examples: ['2E6km', '3E6km'] '15au'
102 102
103 - datacolumn -- when applying a phase center shift, modify visibilities only in
103 + datacolumn -- when applying a phase center shift, modify visibilities only in
104 104 this/these column(s)
105 105 default: 'all' (DATA, CORRECTED, and MODEL)
106 106 example: 'DATA,CORRECTED' (will not modify MODEL)
107 -
107 +
108 108 Examples:
109 109
110 110 fixvis('NGC3256.ms','NGC3256-fixed.ms')
111 111 will recalculate the UVW coordinates for all fields based on the existing
112 112 phase center information in the FIELD table.
113 113
114 114 fixvis('Moon.ms','Moon-fixed.ms','Moon', '', 'J2000 9h25m00s 05d12m00s')
115 115 will set the phase center for field 'Moon' to the given direction and recalculate
116 116 the UVW coordinates.
117 117

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut