Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

imager.pb - Function

	Package	synthesis
	Module	imager
	Tool	imager

Applies or corrects for a primary beam

Synopsis
pb(inimage, outimage, incomps, outcomps, operation, pointingcenter, parangle, pborvp, async)

Description

Multiply (operation='apply') or divide (operation='correct') by the primary beam function. The primary beam can be applied to images and/or Componentlists.

If pointingcenter==F then you must specify inimage and the pointing center is taken from its reference direction. Otherwise, pointingcenter must be a Direction measure. It cannot take on the value T.

The applied primary beam function is deterimed as follows. If you used function Imager.setvp to set an external voltage pattern table, then this is where the applied primary beam will come from (regardless of whether you set inimage or not). If you did not run this function, then you must supply argument inimage. The telescope name embedded in its Coordinate System will be used to determine the primary beam function.

Arguments

inimage	in	Input image to apply beam to
		Allowed:	String
		Default:	None
outimage	in	Output image after beam is applied
		Allowed:	String
		Default:	No output image
incomps	in	Input Componentlist table name
		Allowed:	String
		Default:	None
outcomps	in	Output Componentlist table name
		Allowed:	String
		Default:	No output Componentlist
operation	in	Operation
		Allowed:	String from 'apply' or 'correct'
		Default:	'apply'
pointingcenter	in	Pointing center for primary beam application
		Allowed:	F or Direction measure
		Default:	F in CLI or the N. pole in the GUI
parangle	in	Parallactic angle for calculation
		Allowed:	Quantity
		Default:	'0deg'
pborvp	in	Primary Beam or Voltage Pattern
		Allowed:	String from 'pb' or 'vp'
		Default:	'pb'
async	in	Run asynchronously in the background
		Allowed:	Bool
		Default:	!dowait

Returns
Bool

Example

# make a flat image
imgr.make('flat.image');
img := image('flat.image');
arr := img.getchunk();
arr[1:shape(arr)[1], 1:shape(arr)[2]] := 1.0;
img.putchunk(arr);
img.done()
arr := F;
#
# as we are using "pointingcenter=F", it defaults to the image center
imgr.pb(inimage='flat.image', outimage='pb.image', pointingcenter=F)