Commits

David Mehringer authored 179ca3c79ec
CAS-10308 corrected documentation

gcwrap/tasks/imval.xml

Modified
12 12
13 13
14 14 <input>
15 15 <param type="string" name="imagename" mustexist="true" >
16 16 <description>Name of the input image</description>
17 17 <value></value>
18 18 <example>imagename='ngc5921_task.image'</example>
19 19 </param>
20 20
21 21 <param type="any" name="region">
22 - <description>Region selection. Default is to use the full image.</description>
22 + <description>Region selection. Empty string (default) means use rules for box/chans/stokes specification.</description>
23 23 <any type='variant' limittype='string stringArray'/>
24 24 <value type='string'/>
25 25 </param>
26 26
27 27 <param type="string" name="box">
28 - <description>Rectangular region(s) to select in direction plane. Default is to use the entire direction plane.</description>
28 + <description>Rectangular region(s) to select in direction plane. Empty string (default) means use the reference pixel.</description>
29 29 <value/>
30 30 </param>
31 31
32 32 <param type="string" name="chans" >
33 33 <description>Channels to use. Default is to use all channels.</description>
34 34 <value/>
35 35 </param>
36 36
37 37 <param type="string" name="stokes">
38 38 <description>Stokes planes to use. Planes specified must be contiguous. Default is to use all Stokes planes.</description>
99 99 2. A region specified by a set of rectangular
100 100 pixel coordinates, the channel ranges and/or the Stokes.
101 101
102 102 For directed output, run as
103 103 myoutput = imval()
104 104
105 105
106 106 Keyword arguments:
107 107 imagename -- Name of input image
108 108 Default: none; Example: imagename='ngc5921_task.im'
109 - region -- Region selection. Default is to use the full image.
109 + region -- Region selection. Empty string (default) means use rules for box/chans/stokes specification.
110 110 Example: region='myimage.im.rgn'
111 111 region='region1'
112 - box -- Rectangular region to select in direction plane. Default is to use the entire direction plane.
112 + box -- Rectangular region to select in direction plane. Empty string (default) means use the reference pixel.
113 113 Default: '' (referencepixel values for the Directional coord);
114 114 Example: box='10,10,50,50'
115 115 box = '10,10,30,30,35,35,50,50' (two boxes)
116 116 chans -- Channels to use. Default is to use all channels.
117 117 stokes -- Stokes planes to use. Planes specified must be contiguous. Default is to use all Stokes planes.
118 118 Example: stokes='IQUV';
119 119 stokes='I,Q'
120 120
121 121 General procedure:
122 122

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

Add shortcut