Commits

Takeshi Nakazato authored f7cb23d9238 
CAS-12431 eliminate tabs from uvcontsub3.xml
No tags
cb3015a00f8
master

gcwrap/tasks/uvcontsub3.xml

Modified
4 4 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5 5 xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd
6 6 file:///opt/casa/code/xmlcasa/xml/casa.xsd">
7 7 ​
8 8 <task type="function" name="uvcontsub3" category="modeling, manipulation" visibility="experimental">
9 9 <shortdescription>An experimental clone of uvcontsub</shortdescription>
10 10 <description>
11 11 <!-- description is a decoy! Use the example tag for now. -->
12 12 </description>
13 13 <input>
14 - <param type="string" name="vis" mustexist="true">
15 - <description>Name of input MS. Output goes to vis + ".contsub"</description>
16 - <value></value>
17 - </param>
14 + <param type="string" name="vis" mustexist="true">
15 + <description>Name of input MS. Output goes to vis + ".contsub"</description>
16 + <value></value>
17 + </param>
18 18 ​
19 - <param type="string" name="fitspw">
20 - <description>Spectral window:channel selection for fitting the continuum</description>
21 - <value></value>
22 - </param>
19 + <param type="string" name="fitspw">
20 + <description>Spectral window:channel selection for fitting the continuum</description>
21 + <value></value>
22 + </param>
23 23 ​
24 24 <param type="string" name="combine">
25 25 <description>Data axes to combine for the continuum estimation (none ('') or spw)</description>
26 26 <value></value>
27 27 </param>
28 28 ​
29 - <param type="int" name="fitorder">
30 - <description>Polynomial order for the fits</description>
31 - <value>0</value>
32 - </param>
29 + <param type="int" name="fitorder">
30 + <description>Polynomial order for the fits</description>
31 + <value>0</value>
32 + </param>
33 33 ​
34 34 <param type="any" name="field">
35 35 <description>Select field(s) using id(s) or name(s)</description>
36 - <any type="variant" limittypes="string stringArray int intArray"/>
36 + <any type="variant" limittypes="string stringArray int intArray"/>
37 37 <value type="string"></value>
38 38 </param>
39 39 ​
40 - <param type="string" name="spw">
41 - <description>Spectral window selection for output</description>
42 - <value></value>
43 - </param>
44 - <param type="string" name="scan" >
45 - <description>Select data by scan numbers</description>
46 - <value></value>
47 - </param>
48 - <param type="string" name="intent" >
49 - <description>Select data by scan intents</description>
50 - <value></value>
51 - </param>
52 - <param type="any" name="correlation">
53 - <description>Select correlations</description>
54 - <any type="variant" limittypes="string stringArray"/>
55 - <value type="string"></value>
56 - </param>
40 + <param type="string" name="spw">
41 + <description>Spectral window selection for output</description>
42 + <value></value>
43 + </param>
44 + <param type="string" name="scan" >
45 + <description>Select data by scan numbers</description>
46 + <value></value>
47 + </param>
48 + <param type="string" name="intent" >
49 + <description>Select data by scan intents</description>
50 + <value></value>
51 + </param>
52 + <param type="any" name="correlation">
53 + <description>Select correlations</description>
54 + <any type="variant" limittypes="string stringArray"/>
55 + <value type="string"></value>
56 + </param>
57 57 <param type="any" name="observation">
58 58 <description>Select by observation ID(s)</description>
59 - <any type="variant" limittypes="string int"/>
60 - <value type="string"></value>
59 + <any type="variant" limittypes="string int"/>
60 + <value type="string"></value>
61 61 </param>
62 62 </input>
63 63 <example>
64 64
65 - uvcontsub3 is an experimental clone of uvcontsub with the goal of taking
65 + uvcontsub3 is an experimental clone of uvcontsub with the goal of taking
66 66 less time and temporary disk space.
67 67 ​
68 - Continuum fitting and subtraction in the uv plane:
69 -
70 - This task estimates the continuum emission by fitting polynomials to
68 + Continuum fitting and subtraction in the uv plane:
69 +
70 + This task estimates the continuum emission by fitting polynomials to
71 71 the real and imaginary parts of the spectral windows and channels
72 72 selected by fitspw. This fit represents a model of the continuum in
73 73 all channels.
74 -
74 +
75 75 The fitted continuum spectrum is subtracted from all channels
76 76 selected in spw, and the result (presumably only line emission)
77 77 is stored in a <em>new</em> MS (vis + ".contsub").
78 - It will read from the CORRECTED_DATA column of vis if it is present,
79 - or DATA if it is not. Whichever column is read is presumed to have
80 - already been calibrated.
78 + It will read from the CORRECTED_DATA column of vis if it is present,
79 + or DATA if it is not. Whichever column is read is presumed to have
80 + already been calibrated.
81 81 ​
82 82 Keyword arguments:
83 83 vis -- Name of input visibility file
84 84 default: none; example: vis='ngc5921.ms'
85 85 ​
86 - fitspw -- Selection of spectral windows and channels to use in the
87 - fit for the continuum, using general spw:chan syntax.
88 - See the note under combine.
89 - default: '' (all)
86 + fitspw -- Selection of spectral windows and channels to use in the
87 + fit for the continuum, using general spw:chan syntax.
88 + See the note under combine.
89 + default: '' (all)
90 90 example: fitspw='0:5~30;40~55'
91 91 ​
92 92 combine -- Let the continuum estimation span multiple spectral windows.
93 93 default = '' (Make separate estimates for each spw.)
94 94 combine = 'spw': Necessary when one or more of the spws are
95 95 completely blanketed by lines, so the estimate
96 96 must be made in different spws.
97 97 ​
98 - fitorder -- Polynomial order for the fits of the continuum w.r.t.
98 + fitorder -- Polynomial order for the fits of the continuum w.r.t.
99 99 frequency. fitorders &gt; 1 are strongly discouraged
100 100 because high order polynomials have more flexibility, may
101 101 absorb line emission, and tend go wild at the edges of
102 102 fitspw, which is not what you want.
103 103 ​
104 - default: 0 (constant); example: fitorder=1
104 + default: 0 (constant); example: fitorder=1
105 105 ​
106 106 field -- Field selection for continuum estimation and subtraction.
107 107 The estimation and subtraction is done for each selected field
108 108 in turn. (Run listobs to get lists of the ID and names.)
109 109 default: ''=all fields. If the field string is a non-negative
110 110 integer, it is assumed to be a field index
111 111 otherwise, it is assumed to be a field name
112 112 field='0~2'; field ids 0,1,2
113 113 field='0,4,5~7'; field ids 0,4,5,6,7
114 114 field='3C286,3C295'; fields named 3C286 and 3C295
115 115 field = '3,4C*'; field id 3, all names starting with 4C
116 116 ​
117 117 spw -- Select spectral windows for the output.
118 118 default: ''=all spectral windows
119 119 N.B. uvcontsub3 does not yet support exclusion by channels for
120 120 the output. Meanwhile, use split to further reduce the size
121 121 of the output MS if desired.
122 122 spw='0~2,4'; spectral windows 0,1,2,4
123 123 spw='&lt;2'; spectral windows less than 2 (i.e. 0,1)
124 124 ​
125 - scan -- Scan number range
125 + scan -- Scan number range
126 126 default: ''=all
127 127 ​
128 128 intent -- Select by scan intent (state). Case sensitive.
129 129 default: '' = all
130 130 Examples:
131 131 intent = 'CALIBRATE_ATMOSPHERE_REFERENCE'
132 132 intent = 'calibrate_atmosphere_reference'.upper() # same as above
133 133 # Select states that include one or both of CALIBRATE_WVR.REFERENCE
134 134 # or OBSERVE_TARGET_ON_SOURCE.
135 135 intent = 'CALIBRATE_WVR.REFERENCE, OBSERVE_TARGET_ON_SOURCE'

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

Add shortcut