Synopsis

Delete an image from a crate.

delete_piximg(crate)

Description

• crate - input crate

The delete_piximg command removes the image from the crate. The command returns a "1" if the image is successfully deleted.

The image is only deleted from the data in the crate; it's not removed from the input file. The write_file command ("ahelp write_file") can be used to save the modified crate to a file.

Example

>>> cr = read_file("image.fits")
>>> print(get_piximg_shape(cr))
[512 512]
>>> delete_piximg(cr)
1

Delete the image from the crate.

CHANGES IN CIAO 4.2

The command was renamed from delete_image to delete_piximg in CIAO 4.2 to avoid a conflict with a ChIPS command of the same name.

Bugs

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

See Also

py.crates

add_col, add_key, add_piximg, copy_piximgvals, delete_col, delete_key, get_piximg, get_piximg_shape, get_piximgvals, read_arf, read_file, read_pha, read_rmf, set_piximgvals, write_arf, write_file, write_pha, write_rmf

py.crates_contrib

make_table_crate, scale_image_crate, write_columns