Last modified: December 2013

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


AHELP for CIAO 4.11 ChIPS v1

hide_image

Context: images

Synopsis

Hide the specified image.

Syntax

hide_image()
hide_image(id)

Description

The function arguments.

Argument Description
id A ChipsId structure identifying the item, or a string containing the name of the object.

If no argument is given then the current image is hidden, otherwise the argument determines what to hide. Note that this does not delete anything; use the display_image command to make the items visible again.


Examples

Example 1

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

Create a image, then hide it.

Example 2

chips> add_image('image.fits', 'id=events')
chips> add_image('image2.fits')
chips> id = ChipsId()
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.

See Also

concepts
chipsid, currency
contrib
chips_helix, imextent
images
add_image, current_image, delete_image, display_image, get_image, load_colormap, print_image, remove_image_channel, set_image, shuffle_image