Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

image.setrestoringbeam - Function

	Package	general
	Module	images
	Tool	image

Set the restoringbeam

Synopsis
setrestoringbeam(major, minor, pa, beam, delete, log)

Arguments

major	in	Major axis FWHM
		Allowed:	Quantity or float
		Default:	Unset
minor	in	Minor axis FWHM
		Allowed:	Quantity or float
		Default:	Unset
pa	in	Position angle
		Allowed:	Quantity or float
		Default:	Unset
beam	in	The complete restoring beam
		Allowed:	Record
		Default:	Unset
delete	in	Delete the restoring beam
		Allowed:	T or F
		Default:	F
log	in	Write new beam values to the logger
		Allowed:	T or F
		Default:	F

Returns
T or fail

Description

This function (short-hand name srb) sets the restoring beam. Do not do this unless it is a correct thing to do !

You may supply the beam in one of two ways.

First, you can use the argument beam which you must assign to a Glish record containing fields 'major', 'minor' and 'postionangle'. Each of these fields contains a quantity. This record is in the same format as one returned by function restoringbeam. If you leave beam unset, no action with it is taken. If the function argument beam is used, the arguments major, minor, & pa are ignored.

Second, you can use the arguments major, minor and pa. Only the ones that you assign are used. Each argument should be assigned either a quantity or a float (units are implicitly those of the current beam - or if none, arcsec for the axes and degrees for the position angle).

You may also delete the restoring beam by setting delete=T (all other arguments are then ignored).

Example

- im := image('hcn')      
- rb := im.restoringbeam()
- rb
[major=[value=35, unit=arcsec], 
 minor=[value=13, unit=arcsec], 
 positionangle=[value=80, unit=deg]] 
-
- rb.minor.value := 12.5
- im.setrestoringbeam(beam=rb)
- im.restoringbeam()
[major=[value=35, unit=arcsec], 
 minor=[value=12.5, unit=arcsec], 
 positionangle=[value=80, unit=deg]] 
-
- im.setrestoringbeam(major=36)
- im.restoringbeam()
[major=[value=36, unit=arcsec], 
 minor=[value=12.5, unit=arcsec], 
 positionangle=[value=80, unit=deg]]