Last modified: December 2020

URL: https://cxc.cfa.harvard.edu/sherpa/ahelp/load_image.html
Jump to: · Examples · PARAMETERS · Notes · Bugs · See Also


AHELP for CIAO 4.13 Sherpa v1

load_image

Context: data

Synopsis

Load an image as a data set.

Syntax

load_image(id, arg=None, coord='logical', dstype=DataIMG)

id - int or str, optional
coord - { 'logical', 'image', 'physical', 'world', 'wcs' }
dstype - optional

Examples

Example 1

Load the image from the file "img.fits" into the default data set:

>>> load_image('img.fits')

Example 2

Set the 'bg' data set to the contents of the file "img_bg.fits":

>>> load_image('bg', 'img_bg.fits')

PARAMETERS

The parameters for this function are:

Parameter Definition
id The identifier for the data set to use. If not given then the default identifier is used, as returned by `get_default_id` .
arg Identify the image data: a file name, or a data structure representing the data to use, as used by the I/O backend in use by Sherpa: an imagecrate for crates, as used by CIAO, or a list of AstroPy HDU objects.
coord The coordinate system to use. The 'image' option is the same as 'logical', and 'wcs' the same as 'world'.
dstype The data class to use. The default is `DataIMG` .

Notes

The function does not follow the normal Python standards for parameter use, since it is designed for easy interactive use. When called with a single un-named argument, it is taken to be the `arg` parameter. If given two un-named arguments, then they are interpreted as the `id` and `arg` parameters, respectively. The remaining parameters are expected to be given as named arguments.


Bugs

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

See Also

data
dataspace1d, dataspace2d, datastack, fake, load_arf, load_arrays, load_ascii, load_bkg, load_bkg_arf, load_bkg_rmf, load_data, load_grouping, 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_image, 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_interpolator, 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