Last modified: December 2013

URL: https://cxc.cfa.harvard.edu/chips/ahelp/current_contour.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.11 ChIPS v1

current_contour

Context: contours

Synopsis

Set the specified contour as current.

Syntax

current_contour(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_contour command sets the contour indicated by the argument as the current contour; 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.


Examples

Example 1

chips> id = ChipsId()
chips> add_contour([[1,1,1], [1,3,1], [1,1,1]], 3,3,
[1.1,1.5,2,2.5],'id=levels')
chips> add_contour([1,2,5,3,3,6,0,0,1],3,3)
chips> id.contour = "levels"
chips> hide_contour(id)
chips> current_contour(id)

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

The output of info_current for this session is:

chips> print(info_current())
Window [win1]
  Frame [frm1]
    Plot [plot1]
        X Axis [ax1]
        Y Axis [ay1]
        Contour [levels]
   Coord Sys [Data]
   Coord Sys ID [plot1_ax1ay1]

Example 2

chips> add_contour([[1,1,1], [1,3,1], [1,1,1]], 3,3,
[1.1,1.5,2,2.5],'id=levels')
chips> add_contour([1,2,5,3,3,6,0,0,1],3,3)
chips> current_contour("levels")

Two contours are created. After the second contour is created, it is current. The current_contour command then sets the first contour as the current contour.

Example 3

chips> add_contour([[1,1,1], [1,3,1], [1,1,1]], 3,3,
[1.1,1.5,2,2.5],'color=lime style=solid')
chips> add_contour([1,2,5,3,3,6,0,0,1],3,3)
chips> current_contour("all")

Two contours are created. After the second contour is created, it is current. The current_contour command then makes all contours current.


Bugs

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

See Also

concepts
chipsid, currency
contours
add_contour, delete_contour, display_contour, get_contour, hide_contour, set_contour, shuffle_contour