Commits

Kazuhiko Shimada authored 4a5d9dba716
CAS-13520: add imbaseline.xml

casatasks/xml/imbaseline.xml

Added
1 +<casaxml xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd file:///opt/casa/code/xmlcasa/xml/casa.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://casa.nrao.edu/schema/psetTypes.html">
2 +
3 +<task category="analysis" name="imbaseline" type="function">
4 +<shortdescription>Image-based baseline subtraction for single-dish data</shortdescription>
5 +
6 +<description>Image-based baseline subtraction for single-dish data</description>
7 +
8 +<input>
9 + <param mustexist="true" kind="image" name="imagename" type="path">
10 + <shortdescription>Name of the input spectral line image</shortdescription>
11 + <description>Name of the input spectral line image</description>
12 + <value/>
13 + </param>
14 +
15 + <param kind="text" name="linefile" type="path">
16 + <shortdescription>output continuum subtracted image file name. If it is not specified, it will be imagename + &quot;_bs&quot;.</shortdescription>
17 + <description>output continuum subtracted image file name. If it is not specified, it will be imagename + &quot;_bs&quot;.</description>
18 + <value/>
19 + </param>
20 +
21 + <param name="output_cont" type="bool">
22 + <shortdescription>output continuum image. Name will be imagename + &quot;.cont&quot;</shortdescription>
23 + <description>output continuum image. Name will be imagename + &quot;.cont&quot;</description>
24 + <value type="bool">False</value>
25 + </param>
26 +
27 + <param kind="text" name="bloutput" type="path">
28 + <shortdescription>name of file in which best-fit parameters are written. No output if &quot;&quot; (default).</shortdescription>
29 + <description>name of file in which best-fit parameters are written. No output if &quot;&quot; (default).</description>
30 + <value/>
31 + </param>
32 +
33 + <param type="string" name="maskmode">
34 + <shortdescription>mode of setting additional channel masks. &quot;list&quot; and &quot;auto&quot; are available now.</shortdescription>
35 + <description>mode of setting additional channel masks. &quot;list&quot; and &quot;auto&quot; are available now.</description>
36 + <value>list</value>
37 + <allowed kind="enum" ignorecase="true">
38 + <value>auto</value>
39 + <value>list</value>
40 +
41 + </allowed>
42 + </param>
43 +
44 + <param subparam="true" name="chans" type="string"><shortdescription>Channels to be included in the fitting</shortdescription><description>Channels to be included in the fitting</description>
45 +
46 + <value/>
47 + </param>
48 +
49 + <param subparam="true" name="thresh" type="double"><shortdescription>S/N threshold for linefinder</shortdescription><description>S/N threshold for linefinder</description>
50 +
51 + <value>5.0</value>
52 + </param>
53 +
54 + <param subparam="true" name="avg_limit" type="int"><shortdescription>channel averaging for broad lines</shortdescription><description>channel averaging for broad lines</description>
55 +
56 + <value>4</value>
57 + </param>
58 +
59 + <param subparam="true" name="minwidth" type="int"><shortdescription>the minimum channel width to detect as a line</shortdescription><description>the minimum channel width to detect as a line</description>
60 +
61 + <value>4</value>
62 + </param>
63 +
64 + <param subparam="true" name="edge" type="intVec"><shortdescription>channels to drop at beginning and end of spectrum</shortdescription><description>channels to drop at beginning and end of spectrum</description>
65 +
66 + <value type="intVec"><value>0</value><value>0</value></value>
67 + </param>
68 +
69 + <param type="string" name="blfunc">
70 + <shortdescription>baseline model function [&quot;poly&quot;, &quot;chebyshev&quot;, &quot;cspline&quot;, &quot;sinusoid&quot;, or &quot;variable&quot;(expert mode)]</shortdescription>
71 + <description>baseline model function [&quot;poly&quot;, &quot;chebyshev&quot;, &quot;cspline&quot;, &quot;sinusoid&quot;, or &quot;variable&quot;(expert mode)]</description>
72 + <value>poly</value>
73 + <allowed kind="enum" ignorecase="true">
74 + <value>poly</value>
75 + <value>chebyshev</value>
76 + <value>cspline</value>
77 + <value>sinusoid</value>
78 + <value>variable</value>
79 + </allowed>
80 + </param>
81 +
82 + <param subparam="true" name="order" type="int"><shortdescription>order of baseline model function</shortdescription><description>order of baseline model function</description>
83 +
84 + <value>5</value>
85 + </param>
86 +
87 + <param subparam="true" name="npiece" type="int"><shortdescription>number of element polynomials for cubic spline curve</shortdescription><description>number of element polynomials for cubic spline curve</description>
88 +
89 + <value>3</value>
90 + </param>
91 +
92 + <param subparam="true" name="applyfft" type="bool"><shortdescription>automatically set wave numbers of sinusoids</shortdescription><description>automatically set wave numbers of sinusoids</description>
93 +
94 + <value>True</value>
95 + </param>
96 +
97 + <param subparam="true" name="fftthresh" type="double"><shortdescription>threshold to select wave numbers of sinusoids</shortdescription><description>threshold to select wave numbers of sinusoids</description>
98 +
99 + <value>3.0</value>
100 + </param>
101 +
102 + <param subparam="true" name="addwn" type="intVec"><shortdescription>additional wave numbers to use</shortdescription><description>additional wave numbers to use</description>
103 +
104 + <value type="intVec"><value>0</value></value>
105 + </param>
106 +
107 + <param subparam="true" name="rejwn" type="intVec"><shortdescription>wave numbers NOT to use</shortdescription><description>wave numbers NOT to use</description>
108 +
109 + <value type="intVec"/>
110 + </param>
111 +
112 + <param subparam="true" name="blparam" type="string"><shortdescription>text file that stores per spectrum fit parameters</shortdescription><description>text file that stores per spectrum fit parameters</description>
113 +
114 + <value/>
115 + </param>
116 +
117 + <param subparam="true" name="clipniter" type="int"><shortdescription>maximum iteration number for iterative fitting</shortdescription><description>maximum iteration number for iterative fitting</description>
118 +
119 + <value>0</value>
120 + </param>
121 +
122 + <param subparam="true" name="clipthresh" type="double"><shortdescription>clipping threshold for iterative fitting</shortdescription><description>clipping threshold for iterative fitting</description>
123 +
124 + <value>3.0</value>
125 + </param>
126 +
127 + <param name="dirkernel" type="string">
128 +
129 + <shortdescription>Type of kernel to use to direction plane smoothing. Acceptable values are &quot;none&quot; to omit smoothing(default), &quot;boxcar&quot; for a boxcar kernel, &quot;gaussian&quot; for a gaussian kernel, &quot;image&quot; to use an image as the kernel.</shortdescription>
130 + <description>Type of kernel to use to direction plane smoothing. Acceptable values are &quot;none&quot; to omit image smoothing(default), &quot;boxcar&quot; for a boxcar kernel, &quot;gaussian&quot; for a gaussian kernel, &quot;image&quot; to use an image as the kernel.</description>
131 + <value>none</value>
132 + <allowed kind="enum">
133 + <value>none</value>
134 + <value>gaussian</value>
135 + <value>boxcar</value>
136 + <value>image</value>
137 + </allowed>
138 + </param>
139 +
140 + <param subparam="true" name="major" type="string">
141 +
142 + <shortdescription>Major axis for the kernels. Standard quantity representation. Must be specified for dirkernel=&quot;boxcar&quot; or &quot;gaussian&quot;.</shortdescription>
143 + <description>Major axis for the kernels. Standard quantity representation. Must be specified for dirkernel=&quot;boxcar&quot; or &quot;gaussian&quot;.</description>
144 + <value/>
145 + <example>&quot;4arcsec&quot;</example>
146 + </param>
147 +
148 + <param subparam="true" name="minor" type="string">
149 +
150 + <shortdescription>Minor axis. Standard quantity representation. Must be specified for dirkernel=&quot;boxcar&quot; or &quot;gaussian&quot;.</shortdescription>
151 + <description>Minor axis. Standard quantity representation. Must be specified for dirkernel=&quot;boxcar&quot; or &quot;gaussian&quot;.</description>
152 + <value/>
153 + <example>&quot;2arcsec&quot;</example>
154 + </param>
155 +
156 + <param subparam="true" name="pa" type="string">
157 +
158 + <shortdescription>Position angle used only for gaussian kernel. Standard quantity representation.</shortdescription>
159 + <description>Position angle used only for gaussian kernel. Standard quantity representation.</description>
160 + <value/>
161 + <example>&quot;40deg&quot;</example>
162 + </param>
163 +
164 + <param subparam="true" name="kimage" type="path">
165 + <shortdescription>Kernel image name. Only used if dirkernel=&quot;image&quot;.</shortdescription>
166 + <description>Kernel image name. Only used if dirkernel=&quot;image&quot;.</description>
167 + <value/>
168 + </param>
169 +
170 + <param subparam="true" name="scale" type="double">
171 +
172 + <shortdescription>Scale factor. -1.0 means auto-scale. Only used if dirkernel=&quot;image&quot;.</shortdescription>
173 + <description>Scale factor. -1.0 means auto-scale. Only used if dirkernel=&quot;image&quot;.</description>
174 +
175 + <value>-1.0</value>
176 + </param>
177 +
178 + <param name="spkernel" type="string">
179 +
180 + <shortdescription>Type of spectral smoothing kernel. Acceptable values are &quot;none&quot; to omit smoothing(default), &quot;gaussian&quot; for a gaussian kernel, &quot;boxcar&quot; for a boxcar kernel.</shortdescription>
181 + <description>Type of spectral smoothing kernel. Acceptable values are &quot;none&quot; to omit smoothing(default), &quot;gaussian&quot; for a gaussian kernel, &quot;boxcar&quot; for a boxcar kernel.</description>
182 + <value>none</value>
183 + <allowed kind="enum">
184 + <value>none</value>
185 + <value>gaussian</value>
186 + <value>boxcar</value>
187 + </allowed>
188 + </param>
189 +
190 + <param subparam="true" name="kwidth" type="int">
191 + <shortdescription>smoothing kernel width in channel. Only used if spkernel=&quot;gaussian&quot; or &quot;boxcar&quot;.</shortdescription>
192 + <description>smoothing kernel width in channel. Only used if spkernel=&quot;gaussian&quot; or &quot;boxcar&quot;.</description>
193 + <value>5</value>
194 + </param>
195 +
196 + <constraints>
197 + <when param="maskmode">
198 + <equals value="list"/>
199 + <equals value="auto">
200 + <default param="thresh"><value>5.0</value></default>
201 + <default param="avg_limit"><value>4</value></default>
202 + <default param="minwidth"><value>4</value></default>
203 + <default param="edge"><value type="vector"><value>0</value><value>0</value></value></default>
204 + </equals>
205 + </when>
206 +
207 + <when param="blfunc">
208 + <equals value="poly">
209 + <default param="order"><value>5</value></default>
210 + <default param="clipthresh"><value>3.0</value></default>
211 + <default param="clipniter"><value>0</value></default>
212 + </equals>
213 + <equals value="chebyshev">
214 + <default param="order"><value>5</value></default>
215 + <default param="clipthresh"><value>3.0</value></default>
216 + <default param="clipniter"><value>0</value></default>
217 + </equals>
218 + <equals value="cspline">
219 + <default param="npiece"><value>2</value></default>
220 + <default param="clipthresh"><value>3.0</value></default>
221 + <default param="clipniter"><value>0</value></default>
222 + </equals>
223 + <equals value="sinusoid">
224 + <default param="applyfft"><value>True</value></default>
225 + <default param="fftmethod"><value type="string">fft</value></default>
226 + <default param="fftthresh"><value type="double">3.0</value></default>
227 + <default param="addwn"><value type="intVec"><value>0</value></value></default>
228 + <default param="rejwn"><value type="intVec"/></default>
229 + <default param="clipthresh"><value>3.0</value></default>
230 + <default param="clipniter"><value>0</value></default>
231 + </equals>
232 + <equals value="variable">
233 + <default param="blparam"><value type="string"/></default>
234 + <default param="verbose"><value>False</value></default>
235 + </equals>
236 + </when>
237 +
238 + <when param="dirkernel">
239 + <equals value="gaussian">
240 + <default param="major"><value type="string"/></default>
241 + <default param="minor"><value type="string"/></default>
242 + <default param="pa"><value type="string"/></default>
243 + </equals>
244 + <equals value="boxcar">
245 + <default param="major"><value type="string"/></default>
246 + <default param="minor"><value type="string"/></default>
247 + </equals>
248 + <equals value="image">
249 + <default param="kimage"><value type="string"/></default>
250 + <default param="scale"><value type="double">-1.0</value></default>
251 + </equals>
252 + <equals value="none">
253 + </equals>
254 + </when>
255 +
256 + <when param="spkernel">
257 + <equals value="gaussian">
258 + <default param="kwidth"><value>5</value></default>
259 + </equals>
260 + <equals value="boxcar">
261 + <default param="kwidth"><value>5</value></default>
262 + </equals>
263 + </when>
264 + </constraints>
265 +</input>
266 +<returns type="any"/>
267 +
268 +<example>
269 +
270 +</example>
271 +
272 +</task>
273 +
274 +</casaxml>

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

Add shortcut