casa5
Public
Source
xxxxxxxxxx70
70
<description>Overwrite existing region file?</description>71
71
<value>False</value>72
72
</param>73
73
74
74
</input>75
75
76
76
<returns type="void"/>77
77
78
78
<example>79
79
80
+
80
81
This tool finds all 2-dimensional (RA/dec) regions in the given81
-
image which are contiguous sets of pixels (islands) above the given ]82
+
4D (only!) image which are contiguous sets of pixels (islands) above the given ]82
83
threshold. It creates a box for each island, a rectangular "cutout".83
84
The boxes are stored as regions in the output regionfile. Works on84
85
multi-plane images, but only boxes 2-D regions in each plane.85
86
(Doesn't create cubes/3D boxes.)87
+
88
+
NOTE: THIS TASK WILL NOT WORK ON IMAGES THAT DO NOT HAVE 4 DIMENSIONS WHICH INCLUDE89
+
A DIRECTION COORDINATE, A SPECTRAL COORDINATE, AND A STOKES COORDINATE. If your image90
+
has, eg just a direction coordinate, you can add the required axes using ia.adddegaxes()91
+
and remove them post-run with imsubimage with dropdeg=T.86
92
87
93
imagename -- Name of input images:88
94
default: none; example: imagename='myimage.image'89
95
regionfile -- Name of output region file (adds extension .rgn).90
96
default: none; if not given uses imagename+'.rgn'91
97
threshold -- value (with units) to use for island threshold.92
98
default: 0.0.93
99
maskname -- Optional output mask name.94
100
default: '' (do not write mask image)95
101
chanrange -- Range of channel ids