Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: December 2013

URL: http://cxc.harvard.edu/chips/ahelp/current_region.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.6 ChIPS v1

current_region

Context: regions

Synopsis

Set the specified region as current.

Syntax

current_region(id)

Description

The function arguments.

Argument Description
id A ChipsId structure identifying the item, or a string containing the name of the object.

The current_region command sets the region indicated by the argument as the current region; see "ahelp currency" for general information on currency.

Use the info_current command to retrieve a list of all the current items in the ChIPS session, as shown below.

Example 1

chips> id = ChipsId()
chips> add_region(4, .5, .5, .4, "id=square")
chips> set_region("square", ["edge.color", "white", "fill.color",
"blue", "fill.style", "1"])
chips> add_region(6, .5, .5, .1, "id=hex")
chips> set_region("hex", ["edge.color", "white", "edge.thickness", 2])
chips> id.region = "square"
chips> current_region(id)
chips> info_current()

Two regions are created; the second region is current after it is created. The id.region command sets the region value of the ChipsId structure to the first region, then the current_region command makes that region current.

The output of info_current for this session is:

Window [win1]
  Frame [frm1]
    Plot [plot1]
      Region [square]
    Coord Sys [Plot Normalized]

Example 2

chips> add_region(4, .5, .5, .4, "id=square")
chips> add_region(6, .5, .5, .1, "id=hex")
chips> current_region("square")

Two regions are created. After the second region is created, it is current. The current_region command then sets the first region as the current region.

Example 3

chips> add_region(4, .5, .5, .4, "id=square")
chips> add_region(3, .7, .7, .2)
chips> current_region("all")

Two regions are created. After the second region is created, it is current. The current_region command then makes all regions current.

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.

See Also

concepts
chipsid, currency
contrib
chips_regions
regions
add_region, delete_region, display_region, get_region, hide_region, move_region, set_region, shuffle_region
utilities
load_fill

Last modified: December 2013
Smithsonian Institute Smithsonian Institute

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-2014. All rights reserved.