Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1488

News	FAQ
Search	Home

regionmanager.deletefromtable - Function

	Package	general
	Module	images
	Tool	regionmanager

Delete regions from a Table

Synopsis
deletefromtable(tablename, confirm, regionname)

Arguments

tablename	in	The table
		Allowed:	Image tool, table tool or String
confirm	in	Prompt for confirmation
		Allowed:	T or F
		Default:	F
regionname	in	Name(s) of the region(s) to delete
		Allowed:	Vector of strings

Returns
Bool or fail

Description

This function deletes regions stored in 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).

You specify the name(s) of the regions with the regionname arguments. If you set regionname='all' then all regions are deleted. The names of all the regions stored in a Table can be found with the function namesintable.

Example

- im := image('hcn')
- names := drm.namesintable(im)
- drm.deletefromtable(im, F, names)

In this example, we delete all of the regions in a table, if there are any. The regions are deleted without confirmation prompting.