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

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


AHELP for CIAO 4.9 ChIPS v1

current_colorbar

Context: images

Synopsis

Set the specified colorbar as current.

Syntax

current_colorbar(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_colorbar command sets the colorbar indicated by the argument as the current colorbar; 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_colorbar(0, .5, "id=vert orientation=vertical")
chips> add_colorbar(.5, -.05)
chips> id.colorbar = "vert"
chips> hide_colorbar(id)
chips> current_colorbar(id)
chips> info_current()

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

The output of info_current for this session is:

Window [win1]
  Frame [frm1]
    Plot [plot1]
      X Axis [ax1]
      Y Axis [ay1]
      Image [image1]
      ColorBar [vert]
    Coord Sys [Data]
    Coord Sys ID [plot1_ax1ay1]

Example 2

chips> add_colorbar(0, .5, "id=vert orientation=vertical")
chips> add_colorbar(.5, -.05)
chips> current_colorbar("vert")

Two colorbars are created. After the second colorbar is created, it is current. The current_colorbar command then sets the first colorbar as the current colorbar.

Example 3

chips> add_colorbar(0, .5, "id=vert orientation=vertical")
chips> add_colorbar(0.5, -0.05)
chips> current_colorbar("all")

Two colorbars are created. After the second colorbar is created, it is current. The current_colorbar command then makes all colorbars current.

Bugs

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

See Also

concepts
chipsid, currency
images
add_colorbar, delete_colorbar, display_colorbar, get_colorbar, hide_colorbar, move_colorbar, set_colorbar, shuffle_colorbar

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:   cxchelp@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.