About Chandra Archive Proposer Instruments & Calibration Newsletters Data Analysis HelpDesk Calibration Database NASA Archives & Centers Chandra Science Links

Skip the navigation links
Last modified: December 2006

URL: http://cxc.harvard.edu/ciao3.4/slds9_get_regions.html
Hardcopy (PDF): A4 | Letter
AHELP for CIAO 3.4 ds9_get_regions Context: ds9

Synopsis

Retrieve descriptions of regions applied to a displayed image

Syntax

String_Type[] ds9_get_regions()
String_Type[] ds9_get_regions( [ file_name, handle ] )

Description

Returns a, possibly empty, string array describing the regions that have been applied to the current image frame. Results will be given in the current region file format and coordinate system. The latter defaults to the internal DS9 format, and both may be changed within the Region menu of the GUI.

A stirng passed as the first argument will be interpreted as the name of a file to which the region descriptions should be writted, and will be echoed back to the caller as the onlu element within the results array.

NOTES

Some region formats will prepend one or more comment lines (beginning with a '#') prior to the actual regions, unless the "strip" option has been selected within the GUI.

Hardcopy (PDF): A4 | Letter
Last modified: December 2006



The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory.
60 Garden Street, Cambridge, MA 02138 USA.    Email: cxcweb@head.cfa.harvard.edu
Smithsonian Institution, Copyright © 1998-2004. All rights reserved.