casa5
Public
Source
19
19
<shortdescription>Smooth an image or portion of an image</shortdescription>20
20
21
21
<description>22
22
</description>23
23
24
24
<input>25
25
<param type="string" name="imagename" kind="image" mustexist="true" >26
26
<description>Name of the input image. Must be specified.</description>27
27
<value></value>28
28
</param>29
-
30
29
<param type="string" name="kernel">31
30
<description>Type of kernel to use. Acceptable values are "b", "box", or "boxcar" for a boxcar kernel, "g", "gauss", or "gaussian" for a gaussian kernel, "c", "common", or "commonbeam" to use the common beam of an image with multiple beams as the gaussian to which to convolve all the planes, "i" or "image" to use an image as the kernel.</description>32
31
<value>gauss</value>33
32
<allowed kind="enum">34
33
<value>g</value>35
34
<value>gauss</value>36
35
<value>gaussian</value>37
36
<value>b</value>38
37
<value>box</value>39
38
<value>boxcar</value>40
39
<value>commonbeam</value>41
40
<value>common</value>42
41
<value>c</value>43
42
<value>image</value>44
43
<value>i</value>45
44
</allowed>46
45
</param>47
-
48
46
<param type="any" name="major" subparam="yes">49
-
<description>Major axis for the kernels. Standard quantity representation. Must be specified for kernel="boxcar". Example: "4arcsec".</description>50
-
<any type='variant' limittype='string int float record'/>47
+
<description>Major axis for the kernels. Standard quantity representation. Must be specified for kernel="boxcar".</description>48
+
<any type='variant' limittype='string int float record'/>51
49
<value type="string"/>50
+
<example>"4arcsec"</example>52
51
</param>53
-
54
52
<param type="any" name="minor" subparam="yes">55
-
<description>Minor axis. Standard quantity representation. Must be specified for kernel="boxcar". Example: "2arcsec".</description>56
-
<any type='variant' limittype='string int float record'/>53
+
<description>Minor axis. Standard quantity representation. Must be specified for kernel="boxcar".</description>54
+
<any type='variant' limittype='string int float record'/>57
55
<value type="string"/>56
+
<example>"2arcsec"</example>58
57
</param>59
-
60
58
<param type="any" name="pa" subparam="yes">61
-
<description>Position angle used only for gaussian kernel. Standard quantity representation. Example: "40deg".</description>62
-
<any type='variant' limittype='string int float record'/>59
+
<description>Position angle used only for gaussian kernel. Standard quantity representation.</description>60
+
<any type='variant' limittype='string int float record'/>63
61
<value type="string"/>62
+
<example>"40deg"</example>64
63
</param>65
64
<param type="bool" name="targetres" subparam="yes">66
65
<description>If gaussian kernel, specified parameters are to be resolution of output image (True) or parameters of gaussian to convolve with input image (False).</description>67
66
<!--68
67
from a usability point of view I'd say the default value should be True,69
68
but it has to be False for backwards compatibility70
69
-->71
70
<value type="bool">False</value>72
71
</param>73
72
<param type="string" name="kimage" subparam="yes">92
91
<value/>93
92
</param>94
93
<param type="string" name="stokes">95
94
<description>Stokes planes to use. Default is to use all Stokes planes.</description>96
95
<value/>97
96
</param>98
97
<param type="string" name="mask">99
98
<description>Mask to use. Default is none.</description>100
99
<value/>101
100
</param>102
-
103
-
104
101
<param type="string" name="outfile" >105
102
<description>Output image name. Must be specified.</description>106
103
<value/>107
104
</param>108
105
<param type="bool" direction="in" name="stretch" subparam="true">109
-
<description>Stretch the mask if necessary and possible? </description>106
+
<description>If true, stretch the mask if necessary and possible.</description>110
107
<value>False</value>111
108
</param>112
109
<param type="bool" name="overwrite">113
-
<description>Overwrite (unprompted) pre-existing output file?</description>110
+
<description>If true, overwrite (unprompted) pre-existing output file.</description>114
111
<value>False</value>115
112
</param>116
113
<param type="any" name="beam" subparam="yes">117
114
<any type='variant' limittype='string record'/>118
-
<description>Alternate way of describing a Gaussian. If specified, must be a dictionary with keys "major", "minor", and "pa" (or "positionangle"). Do not specify beam if specifying major, minor, and pa. Example: Example: {"major": "5arcsec", "minor": "2arcsec", "pa": "20deg"}.</description>115
+
<description>Alternate way of describing a Gaussian. If specified, must be a dictionary with keys "major", "minor", and "pa" (or "positionangle"). Do not specify beam if specifying major, minor, and pa.</description>119
116
<value type="string"/>117
+
<example>{"major": "5arcsec", "minor": "2arcsec", "pa": "20deg"}</example>120
118
</param>121
-
122
119
<constraints>123
120
<when param="kernel">124
121
<equals value="gauss">125
122
<default param="beam"><value type="string"></value></default>126
123
127
124
<!--128
125
from a usability point of view I'd say the default value should be True,129
126
but it has to be False for backwards compatibility130
127
-->131
128
<default param="targetres"><value type="bool">False</value></default>