unpack_image

Synopsis

Unpack image data from an IMAGECrate

unpack_image( filename|IMAGECrate, [coord="logical"] )

Description

The unpack_image command unpacks an image from a FITS file or an IMAGECrate into a Sherpa data object.

If a filename is provided as input, a crate is created but hidden and cannot be used for other analysis in the session.

• filename|PHACrate - the name of the file (with path) or PHACrate which contains the PHA data
• coord - the coordinate system: logical, image, physical, world, or wcs; default=logical

Example 1

sherpa> img = unpack_image("img.fits")

Unpack an image from the file img.fits using the default coordinate system (logical).

Example 2

sherpa> psfdat = unpack_image("psf.fits", coord="world")

An image is unpacked from the file psf.fits with world coordinate system.

Example 3

sherpa> imgcr = read_file("source.img")
sherpa> data = unpack_image(imgcr)

The image is read into an IMAGECrate (named "imgcr") from source.img. The image data is then unpacked into Sherpa from the crate.

Bugs

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

See Also

data

dataspace1d, dataspace2d, fake, load_arf, load_arrays, load_ascii, load_bkg, load_bkg_arf, load_bkg_rmf, load_data, load_grouping, load_image, load_multi_arfs, load_multi_rmfs, load_pha, load_quality, load_rmf, load_staterror, load_syserror, load_table, pack_image, pack_pha, pack_table, unpack_arf, unpack_arrays, unpack_ascii, unpack_bkg, unpack_data, unpack_pha, unpack_rmf, unpack_table

filtering

load_filter

info

get_default_id, list_bkg_ids, list_data_ids

modeling

add_model, add_user_pars, image_model, image_model_component, image_source, image_source_component, load_table_model, load_template_model, load_user_model, save_model, save_source

psfs

image_kernel

saving

save_arrays, save_data, save_delchi, save_error, save_filter, save_grouping, save_image, save_pha, save_quality, save_resid, save_staterror, save_syserror, save_table

statistics

load_user_stat

visualization

contour, contour_data, contour_model, contour_ratio, contour_resid, image_close, image_data, image_deleteframes, image_fit, image_getregion, image_open, image_ratio, image_resid, image_setregion, image_xpaget, image_xpaset