image.restoringbeam

Get the restoringbeam

Synopsis
restoringbeam()

Returns
Glish record or fail

Description

This function (short-hand name rb) gets the restoring beam, if any. It is returned in a Glish record with fields 'major', 'minor' and 'postionangle'. Each of these fields contains a quantity. If there is no restoring beam, this function returds an empty record.

You can set the restoring beam with function setrestoringbeam.

Example

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

Next: image.sepconvolve - Function Up: image - Tool Previous: image.replacemaskedpixels - Function Contents Index

	Package	general
	Module	images
	Tool	image

image.restoringbeam - Function