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

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


AHELP for CIAO 4.9 ChIPS v1

current_line

Context: lines

Synopsis

Set the specified line as current.

Syntax

current_line(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_line command sets the line indicated by the argument as the current line; 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_line(.1, .3, .9, .3, "id=flat")
chips> add_line(.3, .8, .8, .2, "id=slope")
chips> id.line = "flat"
chips> current_line(id)

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

The output of info_current for this session is:

chips> print(info_current())
Window [win1]
  Frame [frm1]
    Plot [plot1]
      Line [flat]
    Coord Sys [Plot Normalized]

Example 2

chips> add_line(.1, .3, .9, .3, "id=flat")
chips> add_line(.3, .8, .8, .2)
chips> current_line("flat")

Two lines are created. After the second line is created, it is current. The current_line command then sets the first line as the current line.

Example 3

chips> add_line(.1, .3, .9, .3, "id=flat")
chips> add_line(.3, .8, .8, .2, "id=slope")
chips> current_line("all")

Two lines are created. After the second line is created, it is current. The current_line command then makes all lines current.

Bugs

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

See Also

concepts
chipsid, currency
lines
add_hline, add_line, add_vline, delete_line, display_line, get_line, hide_line, move_line, set_line, shuffle_line

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.