Commits

Akeem Wells authored 00acc41f90a Merge
Merge branch 'master' into CAS-14307

casa5/gcwrap/tasks/msuvbin.xml

Modified
1 -<?xml version="1.0" encoding="UTF-8"?>
2 -<?xml-stylesheet type="text/xsl" ?>
3 -<casaxml xmlns="http://casa.nrao.edu/schema/psetTypes.html"
4 - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5 - xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd
6 - file:///opt/casa/code/xmlcasa/xml/casa.xsd">
1 +<casaxml xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd file:///opt/casa/code/xmlcasa/xml/casa.xsd" xmlns="http://casa.nrao.edu/schema/psetTypes.html" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
7 2
8 3 <task type="function" name="msuvbin" category="manipulation, imaging" visibility="experimental">
9 4 <shortdescription>grid the visibility data onto a defined uniform grid (in the form of an ms); multiple MS\'s can be done onto the same grid</shortdescription>
10 5 <description>
11 6 msuvbin is a uv gridding task. The use is for large volumes
12 7 of data (from multiple epochs) that needs to be imaged into
13 8 one image. One way of proceeding is to image the epochs and
14 9 average them after wards. Rather than doing this averaging
15 10 the visibilities on a common uv grid has several convenience
16 11 advantages like easily doing the proper weighted averaging and imaging.
17 12 If an output grid already exists and a second ms is gridded on the grid
18 13 then the output grid parameters is ignored but the existant grid is used.
19 14
20 15 </description>
21 16 <input>
22 17 <param type="string" name="vis" mustexist="true">
23 - <description>Name of input visibility file (MS)</description>
18 + <shortdescription>Name of input visibility </shortdescription>
19 + <description>Name of input visibility file (MS)
20 + default: none;
21 + </description>
24 22 <value></value>
25 23 </param>
26 24
27 25 <param type="string" name="field">
28 - <description>Field selection of input ms</description>
26 + <shortdescription>field(s) to select</shortdescription>
27 + <description>Field selection of input ms; use mssel syntax</description>
29 28 <value></value>
30 29 </param>
31 30
32 31 <param type="string" name="spw">
33 - <description>Spw selection</description>
32 + <shortdescription>Spw selection</shortdescription>
33 + <description>Spw selection; mssel syntax </description>
34 34 <value></value>
35 35 </param>
36 36
37 37 <param type="string" name="taql">
38 - <description>TaQl string for data selection</description>
38 + <shortdescription>TaQl string for data selection</shortdescription>
39 + <description>TaQl string for data selection; the advance user can do
40 + sophisticated data selection; see http://casacore.github.io/casacore-notes/199.html
41 + </description>
39 42 <value></value>
40 43 </param>
41 44
42 - <param type="string" name="outvis">
43 - <description>name of output uvgrid</description>
45 + <param type="string" name="outputvis">
46 + <shortdescription>name of output uvgrid</shortdescription>
47 + <description>name of output uvgrid; if it existant the data will be binned additively into
48 + that uvgrid (as long as the parameters match for the grid description). If the gridded ms
49 + exists
50 + and the gridding parameters do not match the ones with which the grid was made---
51 + msuvbin will exit with an exception
52 + </description>
44 53 <value></value>
45 54 </param>
46 55 <param type="string" name="phasecenter">
47 - <description>phase center of uv grid</description>
56 + <shortdescription>phase center of uv grid</shortdescription>
57 + <description>phase center of uv grid; if empty it will default
58 + the first field selected in the input ms
59 + </description>
48 60 <value></value>
49 61 </param>
50 - <param type="int" name="nx">
51 - <description>Number of pixels of grid along the x-axis</description>
52 - <value>1000</value>
53 - </param>
54 - <param type="int" name="ny">
55 - <description>Number of pixels of grid along the y-axis</description>
56 - <value>1000</value>
62 +
63 + <param type="any" name="imsize">
64 + <shortdescription>Number of pixels</shortdescription>
65 + <description>Number of pixels
66 + example:
67 +
68 + imsize = [350,250]
69 + imsize = 500 is equivalent to [500,500]
70 +
71 + To take proper advantage of internal optimized FFT routines, the
72 + number of pixels must be even and factorizable by 2,3,5 only.
73 + To find the nearest optimal imsize to that desired by the user, please use the following tool method:
74 +
75 + from casatools import synthesisutils
76 + su = synthesisutils()
77 + su.getOptimumSize(345)
78 + Output : 360
79 + </description>
80 + <type>int</type><type>intVec</type>
81 + <value type="intVec"><value>100</value></value>
57 82 </param>
83 +
58 84 <param type="string" name="cell">
59 - <description>pixel cell size defined in sky dimension</description>
85 + <shortdescription>pixel cell size defined in sky dimension</shortdescription>
86 + <description>pixel cell size defined in sky dimension
87 + This should be in the units of sky angle. Usually you want to have a pixel size that
88 + is smaller than the maximum resolution that can be expected from the data.
89 +
90 + </description>
60 91 <value>1arcsec</value>
61 92 </param>
93 +
62 94 <param type="int" name="ncorr">
63 - <description>number of correlations to store in grid</description>
95 + <shortdescription>number of correlations to store in grid</shortdescription>
96 + <description>number of correlations to store in grid
97 + if 1 is chosen and data have cross hands, then both XX and YY (or RR and LL)
98 + will be gridded on the same correlation plane (XX or RR as MS V2.0 does not support
99 + I as a correlation type).
100 + if 2 is chosen the parallel hands will be stored on independent grids for each frequency channel
101 + if 4 is chosen the all correlation type will be gridded independently.
102 + </description>
64 103 <value>1</value>
65 104 <allowed kind="enum">
66 105 <value>1</value>
67 106 <value>2</value>
68 107 <value>4</value>
69 108 </allowed>
70 109 </param>
110 +
71 111 <param type="int" name="nchan">
72 - <description>Number of spectral channels in grid</description>
112 + <shortdescription>Number of spectral channels in grid</shortdescription>
113 + <description>
114 + Nunmber of spectral channels in the output grid
115 + </description>
73 116 <value>1</value>
74 117 </param>
75 - <param type="string" name="fstart">
76 - <description>Frequency of first spectral channel</description>
77 - <value>1GHz</value>
118 + <param type="string" name="start">
119 + <shortdescription>Frequency of first spectral channel</shortdescription>
120 + <description>
121 + Frequency of first channel of grid. If left empty, it will try to use the
122 + lowest frequency in the selected data
123 + </description>
124 + <value></value>
78 125 </param>
79 - <param type="string" name="fstep">
80 - <description>spectral channel width</description>
81 - <value>1kHz</value>
126 + <param type="string" name="width">
127 + <shortdescription>spectral channel width</shortdescription>
128 + <description>
129 + Spectral channel width. If left empty the badwidth of the selected data will be divided by the nchan
130 + selected to determine the width of an output channel. This happens only when not output grid already exists.
131 + </description>
132 + <value></value>
82 133 </param>
83 134 <param type="bool" name="wproject">
84 - <description>Do wprojection correction while gridding</description>
135 + <shortdescription>Do wprojection correction while gridding</shortdescription>
136 + <description>
137 + Do wprojection correction while gridding. This should be used with care as it is known to have issues like perfomance
138 + and for Cotton-Schwab style cleaning.
139 + </description>
85 140 <value>False</value>
141 + <allowed>
142 + <value>False</value>
143 + </allowed>
86 144 </param>
87 145 <param type="double" name="memfrac">
88 - <description>Limit how much of memory to use</description>
146 + <shortdescription>Limit how much of memory to use</shortdescription>
147 + <description>
148 + Limit fraction of RAM available to use. Default is half.
149 + </description>
89 150 <value>0.5</value>
90 151 <allowed kind="range">
91 152 <value range="min">0.01</value>
92 153 <value range="max">0.99</value>
93 154 </allowed>
94 155 </param>
95 -
96 -
156 + <param type="string" name="mode">
157 + <shortdescription>when mode= &quot;write_flags_back&quot;Operation mode (bin/write_back_flags)</shortdescription>
158 + <description>when mode will transfer back flag from grid to input ms
159 + For this to work both the original ms and the gridded ms has to exist and the flags will be
160 + transferred from the gridded ms back to original ms. This is provided as a utility to
161 + msuvbinflagger task.
162 + </description>
163 + <value type="string">bin</value>
164 + <allowed kind="enum">
165 + <value>bin</value>
166 + <value>write_flags_back</value>
167 + </allowed>
168 + </param>
169 + <param type="bool" name="flagbackup" subparam="true">
170 + <shortdescription>backup flags before saving flags when using write_flags_back</shortdescription>
171 + <description>Backup flags before saving flags when using write_flags_back
172 + </description>
173 + <value type="bool">False</value>
174 + </param>
175 +
176 + <constraints>
177 + <when param="mode">
178 + <equals type="string" value="write_flags_back">
179 + <default param="flagbackup"><value>False</value></default>
180 + </equals>
181 + </when>
182 + </constraints>
97 183
98 184 </input>
99 -<returns type="void"/>
185 + <returns type="void"/>
186 +
100 187
101 188 <example>
102 189
103 190
104 191
105 192
106 193 Keyword arguments:
107 194 vis -- Name of input visibility file
108 195 default: none; example: vis='ngc5921.ms'
109 196 field -- Field name list
110 197 default: '' ==> all
111 198 field = '1328+307' specifies source '1328+307'
112 199 field = '4' specified field with index 4
113 200 spw -- Spw selection
114 201 default: spw = '' (all spw)
115 202 spw='2'
116 203 taql --TaQl expression for data selection (see https://casacore.github.io/casacore-notes/199.html)
117 204 default taql=''
118 205 Example select all data where U &gt; 1 m in the ms
119 206 taql='UVW[0] &gt; 1'
120 - outvis -- name of output grid
207 + outputvis -- name of output grid
121 208 default: '' The user has to give something here
122 209 phasecenter -- phasecenter of the grid
123 210 default= ''
124 211 phasecenter='J2000 18h03m04 -20d00m45.1'
125 - nx -- number of pixels along the x axis of the grid
126 - default: 1000
127 - nx=1200
128 - ny -- number of pixels along the y axis of the grid
129 - default: 1000
130 - ny=1200
212 + imsize -- number of pixels along the x and y axes of the grid
213 + default=100
214 + imsize=[1000, 1000]
131 215 cell -- cellsize of the grid (given in sky units)
132 216 default: '1arcsec'
133 217 cell='0.1arcsec'
134 218 ncorr -- number of correlation/polarization plane in uv grid (allowed 1, 2, 4)
135 219 default: 1
136 220 ncorr=4
137 221 nchan -- number of spectral channel
138 222 default: 1
139 223 nchan=2000
140 - fstart -- frequency of the first channel
141 - default: '1GHz'; User has to give something useful here
142 - fstep -- spectral channel width
143 - default: '1kHz'
224 + start -- frequency of the first channel
225 + default: ''; User has to give something useful here
226 + width -- spectral channel width
227 + default: ''
144 228 wproject -- do wprojection correction while gridding
145 229 default: False
146 230 wproject=True
147 231 memfrac -- control how much of computer's memory is available for gridding
148 232 default=0.5
149 233 memfrac=0.9
150 234
151 235 </example>
152 236 </task>
153 237 </casaxml>

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

Add shortcut