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

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


AHELP for CIAO 4.5 ChIPS v1

display_region

Context: regions

Synopsis

Display the specified region.

Syntax

display_region()
display_region( [ChipsId] )
display_region( "region_id" )
display_region( "all" )

Description

Depending on the argument, this command displays the current region, the region indicated in a ChipsId structure or by the region_id, or all regions.

  • (no argument) - the current region is displayed.
  • ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
  • region_id - identification tag given to each object that is created; use this to display a specific region.
  • all - displays all regions.

Example 1

chips> add_region(3, .7, .7, .2, "id=tri")
chips> hide_region("tri")
chips> display_region()

Create a region and hide it, then display the current region.

Example 2

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> hide_region("square")
chips> add_region(6, .5, .5, .1, "id=hex")
chips> set_region("hex", ["edge.color", "white", "edge.thickness", 2])
chips> id.region = "square"
chips> display_region(id)

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. That region is then displayed.

Example 3

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

Two regions are created and hidden, then the display_region command displays them both.

Bugs

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

See Also

concepts
chipsid, currency, depthcontrol
contrib
chips_regions
depth
collapse_depths, display_depth, get_default_depth, hide_depth, reindex_depth, set_default_depth
regions
add_region, current_region, delete_region, get_region, hide_region, move_region, set_region, shuffle_region
utilities
load_fill

Last modified: December 2012
CXC logo

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