delete_image

Context: images

Synopsis

Delete the specified image from the plot. If no image is specified, the current image is deleted.

Syntax

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

Description

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

(no argument) - the current image is deleted.
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 delete a specific image.
all - deletes all images.

Example 1

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

Create a image, then delete it.

Example 2

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

Example 3

chips> add_image('evt2_image.fits')
chips> add_image('evt2_image2.fits')
chips> delete_image("all")

Two images are created, then the delete_image command deletes them both.

Bugs

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