Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

deconvolver.boxmask - Function

	Package	general
	Module	deconvolver
	Tool	deconvolver

Construct a mask from blc, trc

Synopsis
boxmask(mask, blc, trc, value)

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 deconvolver to control the region selected in a deconvolution.

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. boxmask does not enforce this requirement.

Arguments

mask		name of mask image
		Allowed:	String
blc		Bottom left corner
		Allowed:	Vector
		Default:	[1,1,1,1]
trc		Top right corner
		Allowed:	Vector
		Default:	image shape
value		Value to fill in
		Allowed:	Float
		Default:	1.0

Returns
Bool

Example

deco.boxmask(mask='bigmask', blc=[56,45,1,1], trc=[87,93,4,1])
deco.clean(mask='bigmask', model='3C273XC1.clean.masked', niter=1000)

Makes the image bigmask, and then sets it to unity for all points in the region bounded by the blc and trc. Then cleans using it as the mask.