Commits

Ville Suoranta authored 92c0a4d9acf Merge
Merge pull request #531 in CASA/casa from hotfix/CAS-11439 to release/5.3.0

* commit '5e13ba5a7d50827e02ac0062850d4f913ae3755e': A minor doc update
No tags

gcwrap/tasks/tclean.xml

Modified
1865 1865 <description>Mask string (image name or region file or region string)
1866 1866 -->
1867 1867 The name of a CASA image or region file or region string that specifies
1868 1868 a 1/0 mask to be used for deconvolution. Only locations with value 1 will
1869 1869 be considered for the centers of flux components in the minor cycle.
1870 1870 If regions specified fall completely outside of the image, tclean will throw an error.
1871 1871
1872 1872 Manual mask options/examples :
1873 1873
1874 1874 mask='xxx.mask' : Use this CASA image named xxx.mask and containing
1875 - ones and zeros as the mask. If this image is a different
1876 - shape from what is being made it will be resampled to
1875 + ones and zeros as the mask. <!--If this image is a different
1876 + spatial coordinates from what is being made it will be resampled to
1877 1877 the target coordinate system before being used.
1878 1878 When a continuum (single channel) mask is given for spectral
1879 1879 cube imaging, it will be extended (copied) to all channels.
1880 1880 Similarly, when a Stokes I mask is given, it will be extended
1881 1881 to multi-Stokes imaging. Extension of a cube stokes I mask
1882 1882 to other Stokes planes is possible only if the spectral
1883 1883 coordinate and the number of the channels matches with the output
1884 1884 image.
1885 + -->
1886 + If the mask is only different in spatial coordinates it will be
1887 + resampled to the target coordinate system before being used.
1888 + The mask has to have the same shape in velocity and Stokes planes
1889 + as the output image. Exceptions are single velocity and/or single
1890 + Stokes plane masks. They will be expanded to cover all velocity and/or
1891 + Stokes planes of the output cube.
1885 1892
1886 1893 [ Note : If an error occurs during image resampling or
1887 1894 if the expected mask does not appear, please try
1888 1895 using tasks 'imregrid' or 'makemask' to resample
1889 1896 the mask image onto a CASA image with the target
1890 1897 shape and coordinates and supply it via the 'mask'
1891 1898 parameter. ]
1892 1899
1900 +
1893 1901 mask='xxx.crtf' : A text file with region strings and the following on the first line
1894 1902 ( #CRTFv0 CASA Region Text Format version 0 )
1895 1903 This is the format of a file created via the viewer's region
1896 1904 tool when saved in CASA region file format.
1897 1905
1898 1906 mask='circle[[40pix,40pix],10pix]' : A CASA region string.
1899 1907
1900 1908 mask=['xxx.mask','xxx.crtf', 'circle[[40pix,40pix],10pix]'] : a list of masks
1901 1909
1902 1910

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

Add shortcut