Commits

Takeshi Nakazato authored 771b2befaff
CAS-12431 eliminate tabs from split.xml
No tags

gcwrap/tasks/split.xml

Modified
11 11 Split is the general purpose program to make a new data set that is a
12 12 subset or averaged form of an existing data set. General selection
13 13 parameters are included, and one or all of the various data columns
14 14 (DATA, LAG_DATA and/or FLOAT_DATA, MODEL_DATA and/or CORRECTED_DATA)
15 15 can be selected.
16 16
17 17 Split is often used after the initial calibration of the data to make
18 18 a smaller Measurement Set with only the data that will be used in
19 19 further flagging, imaging and/or self-calibration. Split can average
20 20 over frequency (channels) and time (integrations).
21 -
21 +
22 22 The split task uses the MSTransform framework underneath. Split also
23 23 supports the Multi-MS (MMS) format as input.
24 24 </description>
25 25
26 26 <input>
27 27 <param type="string" name="vis" mustexist="true">
28 28 <shortdescription>Name of input visibility file</shortdescription>
29 29 <description>Name of input visibility file
30 30 Default: none
31 31
32 32 Example: vis='ngc5921.ms'
33 33 </description>
34 - <value></value>
34 + <value></value>
35 35 </param>
36 36
37 - <param type="string" name="outputvis" mustexist="false">
37 + <param type="string" name="outputvis" mustexist="false">
38 38 <shortdescription>Name of output visibility file</shortdescription>
39 39 <description>Name of output visibility file
40 40 Default: '' (same as vis)
41 41
42 42 Example: outputvis='ngc5921_out.ms'
43 43
44 44 IMPORTANT: if a .flagversions file with the name
45 - of the output MS exist, this task will exit with
46 - an error. The user needs to rename or remove the
47 - existing flagbackup or choose a different output
48 - name for the MS.
45 + of the output MS exist, this task will exit with
46 + an error. The user needs to rename or remove the
47 + existing flagbackup or choose a different output
48 + name for the MS.
49 49 </description>
50 - <value></value>
51 - </param>
50 + <value></value>
51 + </param>
52 52
53 - <!-- MMS-CASE parameters -->
53 + <!-- MMS-CASE parameters -->
54 54 <param type="bool" name="keepmms">
55 55 <shortdescription>If the input is a Multi-MS the output will also be a Multi-MS.</shortdescription>
56 56 <description>Create a Multi-MS as the output if the input is a
57 57 Multi-MS.
58 58 Default: True
59 59 Options: True|False
60 60
61 61 By default it will create a Multi-MS when the
62 - input is a Multi-MS. The output Multi-MS will
63 - have the same partition axis of the input
64 - MMS. See CASA Docs for more information on
65 - the MMS format.
62 + input is a Multi-MS. The output Multi-MS will
63 + have the same partition axis of the input
64 + MMS. See CASA Docs for more information on
65 + the MMS format.
66 66
67 67 NOTE: It is not possible to do time average with
68 - combine='scan' if the input MMS was partitioned
69 - with separationaxis='scan' or 'auto'. In this
70 - case, the task will abort with an error.
68 + combine='scan' if the input MMS was partitioned
69 + with separationaxis='scan' or 'auto'. In this
70 + case, the task will abort with an error.
71 71 </description>
72 72 <value>True</value>
73 73 </param>
74 -
74 +
75 75 <!-- SELECTION parameters -->
76 76 <param type="any" name="field">
77 77 <shortdescription>Select field using field id(s) or field name(s)</shortdescription>
78 78 <description>Select field using field id(s) or field name(s)
79 79 Default: '' (all fields)
80 80
81 81 Use 'go listobs' to obtain the list id's or
82 - names. If field string is a non-negative integer,
83 - it is assumed a field index, otherwise, it is
84 - assumed a field name.
82 + names. If field string is a non-negative integer,
83 + it is assumed a field index, otherwise, it is
84 + assumed a field name.
85 85
86 86 Examples:
87 87 field='0~2'; field ids 0,1,2
88 88 field='0,4,5~7'; field ids 0,4,5,6,7
89 89 field='3C286,3C295'; field named 3C286 and
90 - 3C295
90 + 3C295
91 91 field = '3,4C*'; field id 3, all names
92 - starting with 4C
92 + starting with 4C
93 93 </description>
94 94 <any type="variant" limittypes="string stringArray int intArray"/>
95 95 <value type="string"></value>
96 96 </param>
97 97
98 98 <param type="any" name="spw">
99 -<shortdescription>Select spectral window/channels</shortdescription>
99 +<shortdescription>Select spectral window/channels</shortdescription>
100 100 <description>Select spectral window/channels
101 101 Default: ''=all spectral windows and channels
102 102
103 103 Examples:
104 104 spw='0~2,4'; spectral windows 0,1,2,4 (all channels)
105 105 spw='&lt;2'; spectral windows less than 2 (i.e. 0,1)
106 106 spw='0:5~61'; spw 0, channels 5 to 61
107 107 spw='0,10,3:3~45'; spw 0,10 all channels, spw
108 - 3 - chans 3 to 45.
108 + 3 - chans 3 to 45.
109 109 spw='0~2:2~6'; spw 0,1,2 with channels 2
110 - through 6 in each.
110 + through 6 in each.
111 111 spw = '*:3~64' channels 3 through 64 for all sp id's
112 112 spw = ' :3~64' will NOT work.
113 113
114 114 NOTE: mstransform does not support multiple
115 - channel ranges per spectral window (';').
115 + channel ranges per spectral window (';').
116 116 </description>
117 117 <any type="variant" limittypes="string stringArray int intArray"/>
118 118 <value type="string"></value>
119 119 </param>
120 120
121 121 <param type="any" name="scan" >
122 122 <shortdescription>Scan number range</shortdescription>
123 123 <description>Scan number range
124 124 Subparameter of selectdata=True
125 125 Default: '' = all
128 128 <value type="string"></value>
129 129 </param>
130 130
131 131 <param type="any" name="antenna">
132 132 <shortdescription>Select data based on antenna/baseline</shortdescription>
133 133 <description>Select data based on antenna/baseline
134 134 Subparameter of selectdata=True
135 135 Default: '' (all)
136 136
137 137 If antenna string is a non-negative integer, it
138 - is assumed an antenna index, otherwise, it is
139 - assumed as an antenna name
138 + is assumed an antenna index, otherwise, it is
139 + assumed as an antenna name
140 140
141 141 Examples:
142 142 antenna='5&amp;6'; baseline between antenna
143 - index 5 and index 6.
143 + index 5 and index 6.
144 144 antenna='VA05&amp;VA06'; baseline between VLA
145 - antenna 5 and 6.
145 + antenna 5 and 6.
146 146 antenna='5&amp;6;7&amp;8'; baselines with
147 - indices 5-6 and 7-8
147 + indices 5-6 and 7-8
148 148 antenna='5'; all baselines with antenna index
149 - 5
149 + 5
150 150 antenna='05'; all baselines with antenna
151 - number 05 (VLA old name)
151 + number 05 (VLA old name)
152 152 antenna='5,6,10'; all baselines with antennas
153 - 5,6,10 index numbers
153 + 5,6,10 index numbers
154 154 </description>
155 155 <any type="variant" limittypes="string stringArray int intArray"/>
156 156 <value type="string"></value>
157 157 </param>
158 158
159 159 <param type="any" name="correlation">
160 160 <shortdescription>Select data based on correlation</shortdescription>
161 161 <description>Select data based on correlation
162 162 Default: '' ==> all
163 163
168 168 </param>
169 169
170 170 <param type="any" name="timerange" >
171 171 <shortdescription>Select data based on time range</shortdescription>
172 172 <description>Select data based on time range
173 173 Subparameter of selectdata=True
174 174 Default = '' (all)
175 175
176 176 Examples:
177 177 timerange =
178 - 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
179 - (Note: if YYYY/MM/DD is missing date defaults
180 - to first day in data set.)
178 + 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
179 + (Note: if YYYY/MM/DD is missing date defaults
180 + to first day in data set.)
181 181 timerange='09:14:0~09:54:0' picks 40 min on
182 - first day
182 + first day
183 183 timerange= '25:00:00~27:30:00' picks 1 hr to 3
184 - hr 30min on NEXT day
184 + hr 30min on NEXT day
185 185 timerange='09:44:00' pick data within one
186 - integration of time
186 + integration of time
187 187 timerange='>10:24:00' data after this time
188 188 </description>
189 189 <any type="variant" limittypes="string stringArray int intArray"/>
190 190 <value type="string"></value>
191 191 </param>
192 192
193 193 <param type="any" name="intent" >
194 -<shortdescription>Select observing intent</shortdescription>
194 +<shortdescription>Select observing intent</shortdescription>
195 195 <description>Select observing intent
196 196 Default: '' (no selection by intent)
197 197
198 198 Example: intent='*BANDPASS*' (selects data
199 - labelled with BANDPASS intent)
199 + labelled with BANDPASS intent)
200 200 </description>
201 201 <any type="variant" limittypes="string stringArray int intArray"/>
202 202 <value type="string"></value>
203 203 </param>
204 204
205 205 <param type="any" name="array">
206 206 <shortdescription>Select (sub)array(s) by array ID number.</shortdescription>
207 207 <description>(Sub)array number range
208 208 Default: '' (all)
209 209 </description>
210 210 <any type="variant" limittypes="string stringArray int intArray"/>
211 211 <value type="string"></value>
212 212 </param>
213 213
214 214 <param type="any" name="uvrange" >
215 -<shortdescription>Select data by baseline length.</shortdescription>
215 +<shortdescription>Select data by baseline length.</shortdescription>
216 216 <description>Select data by baseline length.
217 217 Default = '' (all)
218 218
219 219 Examples:
220 220 uvrange='0~1000klambda'; uvrange from 0-1000 kilo-lambda
221 221 uvrange='>4klambda';uvranges greater than 4 kilo-lambda
222 222 uvrange='0~1000km'; uvrange in kilometers
223 223 </description>
224 224 <any type="variant" limittypes="string stringArray int intArray"/>
225 225 <value type="string"></value>
246 246 <any type="variant" limittypes="string stringArray int intArray"/>
247 247 <value type="string"></value>
248 248 </param>
249 249
250 250 <param type="string" name="datacolumn" ignorecase="True">
251 251 <shortdescription>Which data column(s) to process.</shortdescription>
252 252 <description>Which data column(s) to use for processing
253 253 (case-insensitive).
254 254 Default: 'corrected'
255 255 Options: 'data', 'model', 'corrected',
256 - 'all','float_data', 'lag_data',
257 - 'float_data,data', 'lag_data,data'
256 + 'all','float_data', 'lag_data',
257 + 'float_data,data', 'lag_data,data'
258 258
259 259 Example: datacolumn='data'
260 260
261 261 NOTE: 'all' = whichever of the above that are
262 - present. If the requested column does not exist,
263 - the task will exit with an error.
262 + present. If the requested column does not exist,
263 + the task will exit with an error.
264 264 </description>
265 265 <value>corrected</value>
266 266 <allowed kind="enum" ignorecase="True">
267 267 <value>corrected</value>
268 268 <value>data</value>
269 269 <value>model</value>
270 270 <value>data,model,corrected</value>
271 271 <value>float_data</value>
272 272 <value>lag_data</value>
273 273 <value>float_data,data</value>
274 274 <value>lag_data,data</value>
275 275 <value>all</value>
276 276 </allowed>
277 277 </param>
278 278
279 279 <param type="bool" name="keepflags">
280 280 <shortdescription></shortdescription>
281 281 <description>Keep *completely flagged rows* instead of dropping them.
282 282 Default: True (keep completely flagged rows in
283 - the output)
283 + the output)
284 284 Options: True|False
285 285
286 286 Keepflags has no effect on partially flagged
287 - rows. All of the channels and correlations of a
288 - row must be flagged for it to be droppable, and a
289 - row must be well defined to be keepable.
287 + rows. All of the channels and correlations of a
288 + row must be flagged for it to be droppable, and a
289 + row must be well defined to be keepable.
290 290
291 291 IMPORTANT: Regardless of this parameter, flagged
292 - data is never included in channel averaging. On
293 - the other hand, partially flagged rows will
294 - always be included in time averaging. The average
295 - value of the flagged data for averages containing
296 - ONLY flagged data in the relevant output channel
297 - will be written to the output with the
298 - corresponding flag set to True, while only
299 - unflagged data is used on averages where there is
300 - some unflagged data with the flag set to False.
292 + data is never included in channel averaging. On
293 + the other hand, partially flagged rows will
294 + always be included in time averaging. The average
295 + value of the flagged data for averages containing
296 + ONLY flagged data in the relevant output channel
297 + will be written to the output with the
298 + corresponding flag set to True, while only
299 + unflagged data is used on averages where there is
300 + some unflagged data with the flag set to False.
301 301
302 302 </description>
303 303 <value>True</value>
304 304 </param>
305 -
305 +
306 306 <!-- CHANNEL AVERAGING parameters -->
307 - <param type="any" name="width">
307 + <param type="any" name="width">
308 308 <shortdescription>Number of channels to average to form one output channel</shortdescription>
309 309 <description>Number of channels to average to form one output channel
310 310 If a list is given, each bin will apply to one
311 - spw in the selection.
311 + spw in the selection.
312 312 Default: 1 (no channel average)
313 313 Options: (int)|[int]
314 314
315 315 Example: chanbin=[2,3] => average 2 channels
316 - of 1st selected spectral window and 3 in the
317 - second one.
316 + of 1st selected spectral window and 3 in the
317 + second one.
318 318 </description>
319 319 <any type="variant" limittypes="string stringArray int intArray"/>
320 - <value type="int">1</value>
321 - </param>
320 + <value type="int">1</value>
321 + </param>
322 322
323 323 <!-- TIME AVERAGING parameters -->
324 - <param type="string" name="timebin">
324 + <param type="string" name="timebin">
325 325 <shortdescription>Bin width for time averaging</shortdescription>
326 326 <description>Bin width for time averaging
327 327 Default: '0s'
328 328
329 329 Bin width for time averaging. When timebin is
330 - greater than 0s, the task will average data in
331 - time. Flagged data will be included in the
332 - average calculation, unless the parameter
333 - keepflags is set to False. In this case only
334 - partially flagged rows will be used in the
335 - average.
336 -</description>
337 - <value type="string">0s</value>
338 - </param>
339 - <param type="any" name="combine" subparam="true">
330 + greater than 0s, the task will average data in
331 + time. Flagged data will be included in the
332 + average calculation, unless the parameter
333 + keepflags is set to False. In this case only
334 + partially flagged rows will be used in the
335 + average.
336 +</description>
337 + <value type="string">0s</value>
338 + </param>
339 + <param type="any" name="combine" subparam="true">
340 340 <shortdescription>Span the timebin across scan, state or both</shortdescription>
341 341 <description>Let the timebin span across scan, state or both.
342 342 Default: '' (separate time bins by both of the
343 - above)
343 + above)
344 344 Options: 'scan', 'state', 'state,scan'
345 345
346 346 State is equivalent to sub-scans. One scan may
347 - have several state ids. For ALMA MSs, the
348 - sub-scans are limited to about 30s duration
349 - each. In these cases, the task will automatically
350 - add state to the combine parameter. To see the
351 - number of states in an MS, use the msmd tool. See
352 - help msmd.
347 + have several state ids. For ALMA MSs, the
348 + sub-scans are limited to about 30s duration
349 + each. In these cases, the task will automatically
350 + add state to the combine parameter. To see the
351 + number of states in an MS, use the msmd tool. See
352 + help msmd.
353 353
354 354 Examples:
355 355 * combine = 'scan'; can be useful when the scan
356 - number goes up with each integration as in
357 - many WSRT MSs.
356 + number goes up with each integration as in
357 + many WSRT MSs.
358 358 * combine = ['scan', 'state']: disregard scan
359 - and state numbers when time averaging.
359 + and state numbers when time averaging.
360 360 * combine = 'state,scan'; same as above.
361 361
362 362 NOTE: It is not possible to do time average with
363 - combine='scan' if the input MMS was partitioned
364 - with separationaxis='scan' or 'auto'. In this
365 - case, the task will abort with an error.
363 + combine='scan' if the input MMS was partitioned
364 + with separationaxis='scan' or 'auto'. In this
365 + case, the task will abort with an error.
366 366 </description>
367 - <any type="variant" limittypes="string stringArray"/>
368 - <value type="string"></value>
369 - </param>
370 -
371 - <!-- CONSTRAINTS -->
367 + <any type="variant" limittypes="string stringArray"/>
368 + <value type="string"></value>
369 + </param>
370 +
371 + <!-- CONSTRAINTS -->
372 372 <constraints>
373 373 <when param="timebin">
374 374 <notequals type="string" value="0s">
375 375 <default param="combine"><value type="string"></value></default>
376 376 </notequals>
377 377 </when>
378 378 </constraints>
379 379 </input>
380 380 <example>
381 381

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

Add shortcut