current_image

Context: images

Synopsis

Set the image specified by ID or the image field in a ChipsId structure to be current.

Syntax

current_image( ChipsId )
current_image( "image_id" )
current_image( "all" )

Description

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

ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
image_id - identification tag given to each object that is created; use this to select a specific image.
all - sets all images to be current.

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

Example 1

chips> id = ChipsId()
chips> add_image('evt2_image.fits','id=events')
chips> add_image('evt2_image2.fits')
chips> id.image = "events"
chips> hide_image(id)
chips> current_image(id)
chips> info_current()

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

The output of info_current for this session is:

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

Example 2

chips> add_image('evt2_image.fits','id=events')
chips> add_image('evt2_image2.fits')
chips> current_image("events")

Two images are created. After the second image is created, it is current. The current_image command then sets the first image as the current image.

Bugs

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