Getting Started Documentation Glish Learn More Programming Contact Us
Version 1.9 Build 1556
News FAQ
Search Home


next up previous contents index
Next: imager.mem - Function Up: imager - Tool Previous: imager.makemodelfromsd - Function


imager.mask - Function



Package synthesis
Module imager
Tool imager


Construct a mask image by thresholding an image


Synopsis
mask(image, mask, threshold, async)


Description
A mask image is an image with the same shape as the other images but with values between 0.0 and 1.0 as a pixel value. Mask images are used in imager to control the region selected in a deconvolution. One makes a mask image by clipping the I part of the restored image (this function) or via the boxmask, regionmask, and exprmask functions. In this function, all points greater than the threshold are set to unity. The mask is the same in I,Q,U, and V. Note that exprmask is the most powerful method for making mask images.

In the Clark CLEAN, the mask image can usefully have any value between 0.0 and 1.0. Intermediate value discourage but do not rule out selection of clean components in that region. This is accomplished by multiplying the residual image by the mask prior to entering the minor cycle.

Note that if you do use a mask for the Clark or Hogbom Clean, it must cover only a quarter of the image. It is particularly important to check this when creating an image using a threshold. If it extends further, the easiest fix is to use getchunk and getchunk to set parts of it to zero.



Arguments

image in name of template image
Allowed: String
mask in name of mask image
Allowed: String
threshold in threshold for mask
Allowed: Quantity
Default: '0.0Jy'
async in Run asynchronously in the background
Allowed: Bool
Default: !dowait


Returns
Bool


Example
imgr.mask( image='bigimage', mask='bigmask',threshold='0.07Jy')
imgr.clean(mask='bigmask', model='3C273XC1.clean.masked', niter=1000)

Makes the image bigmask, and then sets it to unity for all points where the Stokes I in bigimage is greater than 0.07. Then clean using it as the mask.





next up previous contents index
Next: imager.mem - Function Up: imager - Tool Previous: imager.makemodelfromsd - Function   Contents   Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc., Washington, D.C.

Return to AIPS++ Home Page
2006-10-15