casa / casa6 / 9c6123e701e

Commits

Ville Suoranta authored 9c6123e701e Merge 09 Jan 2022

Merge pull request #501 in CASA/casa6 from CAS-13634 to master

* commit 'b599fc2d681de32b25f570bda521b33ceb041701':
  Corrected the description of the start parameter given as an integer when it is used along with spw containing channel selection.

casatasks/xml/tclean.xml

Modified

-484
+      <value type="int">-1</value>
-485
+    </param>
-486
-487
+    <param type="any" name="start" subparam="true">
-488
+     <shortdescription>First channel (e.g. start=3,start=\'1.1GHz\',start=\'15343km/s\')</shortdescription>
-489
+<description>First channel (e.g. start=3,start=\'1.1GHz\',start=\'15343km/s\')
-490
+                       of output cube images specified by data channel number (integer),
-491
+                       velocity (string with a unit),  or frequency (string with a unit).
-492
+                       Default:''; The first channel is automatically determined based on
-493
+                       the 'spw' channel selection and 'width'.
--
+                       When the channel number is used along with the channel selection
--
+                        in 'spw' (e.g. spw='0:6~100'),
--
+                       'start' channel number is RELATIVE (zero-based) to the selected
--
+                       channels in 'spw'. So for the above example,
--
+                       start=1 means that the first image channel is the second selected
--
+                       data channel, which is channel 7.
-+
+                       channels in 'spw'.
-+
+                       Since the integer number in 'start' represents the data channel number,
-+
+                       when the channel number is used along with the spectral window id selection
-+
+                       in 'spw', 'start' specified as an integer should be carefully set otherwise
-+
+                       it may result in the blank image channels if the 'start' channel (i.e. absolute
-+
+                       channel number) is outside of the channel range specified in 'spw'.
-+
+                       In such a case, 'start' can be left as a default (='') to ensure
-+
+                       matching with the data spectral channel selection.
-502
+                       For specmode='cube', when velocity or frequency is used it is
-503
+                       interpreted with the frame defined in outframe. [The parameters of
-504
+                       the desired output cube can be estimated by using the 'transform'
-505
+                       functionality of 'plotms']
-506
+                       examples: start='5.0km/s'; 1st channel, 5.0km/s in outframe
-507
+                                 start='22.3GHz'; 1st channel, 22.3GHz in outframe
-508
+</description>
-509
+      <value type="string"/>
-510
+    </param>
-511

casa6

Commits

Jira Issues

Add shortcut