hide_image

Context: images

Synopsis

Sets the visibility of the specified image to false. Use display_image() to turn the image's visibility back on.

Syntax

hide_image()
hide_image( [ChipsId] )
hide_image( "image_id" )
hide_image( "all" )

Description

Depending on the argument, this command hides the current image, the image indicated in a ChipsId structure or by the image_id, or all images.

(no argument) - the current image is hidden.
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 hide a specific image.
all - hides all images.

The image is not deleted, just hidden. The display_image command makes it visible again.

Example 1

chips> add_image('evt2_image.fits')
chips> hide_image()

Create a image, then hide the current image.

Example 2

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)

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. That image is then hidden.

Example 3

chips> add_image('evt2_image.fits')
chips> add_image('evt2_image2.fits')
chips> hide_image('all')

Two images are created, then the hide_image command hides them both.

Bugs

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