Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

regionmanager.fromglobaltotable - Function

	Package	general
	Module	images
	Tool	regionmanager

Save regions into a Table

Synopsis
fromglobaltotable(tablename, confirm, verbose, regionname, ...)

Arguments

tablename	inout	The table
		Allowed:	Image tool, table tool or String
confirm	in	Prompt for confirmation
		Allowed:	T or F
		Default:	F
verbose	in	Report successful saves
		Allowed:	T or F
		Default:	T
regionname	in	Name(s) of the region(s) when saved in the table
		Allowed:	Vector of strings
		Default:	Self naming
...	in	Region(s) to save
		Allowed:	Region tool(s)

Returns
Bool or fail

Description

This function saves regions into an AIPS++ Table.

For the tablename argument, you can specify an image tool, a table tool, or a string. If you give a string, it should be the name of an existing AIPS++ table on disk (any kind of table) or a new table which will be created for you. The new table has no useful structure beyond housing the regions for you.

You can specify the name that each region will have (regionname) when it is saved in the Table. If you don't specify this, a name will be made up for you (region1, region2, etc).

Example

- im := image('hcn')
- r1 := drm.box()
- r2 := drm.quarter()
- drm.fromglobaltotable(im, T, F, "x1 x2", r1, r2)
- drm.namesintable(im)
x1 x2

In this example, we save two regions called r1 and r2 to the table (previously containing no regions) referred to by the image tool im. The regions are renamed to `x1' and `x2' as they are stored.

Example

- im := image('hcn')
- r1 := drm.box()
- r2 := drm.quarter()
- drm.fromglobaltotable(im, T, F, "", r1, r2)
- drm.namesintable(im)
x1 x2

In this example, we save two regions called r1 and r2 to the table (previously containing no regions) referred to by the image tool im. The names for regions are made up for us as we don't specify them. Note that because the regions are specified by the special Glish `...' argument (it has no actual argument name), we must give the regionname argument explcitly as an empty vector of strings (else Glish will take the empty string as a region).