Last modified: December 2023

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


AHELP for CIAO 4.16 Sherpa

image_data

Context: visualization

Synopsis

Display a data set in the image viewer.

Syntax

image_data(id=None, newframe=False, tile=False)

id - int or str, optional
newframe - bool, optional
tile - bool, optional

Description

The image viewer is automatically started if it is not already open.


Examples

Example 1

Display the data in default data set.

>>> image_data()

Example 2

Display data set 2 in a new frame so that the data in the current frame is not destroyed. The new data will be displayed in a single frame (i.e. the only data shown by the viewer).

>>> image_data(2, newframe=True)

Example 3

Display data sets 'i1' and 'i2' side by side:

>>> image_data('i1')
>>> image_data('i2', newframe=True, tile=True)

PARAMETERS

The parameters for this function are:

Parameter Definition
id The data set. If not given then the default identifier is used, as returned by `get_default_id` .
newframe Create a new frame for the data? If False , the default, then the data will be displayed in the current frame.
tile Should the frames be tiles? If False , the default, then only a single frame is displayed.

Notes

Image visualization is optional, and provided by the DS9 application.


Bugs

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

See Also

data
copy_data, dataspace1d, dataspace2d, datastack, delete_data, fake, get_axes, get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_source_plot, get_counts, get_data, get_data_contour, get_data_contour_prefs, get_data_image, get_data_plot, get_data_plot_prefs, get_dep, get_dims, get_error, get_quality, get_specresp, get_staterror, get_syserror, group, group_adapt, group_adapt_snr, group_bins, group_counts, group_snr, group_width, load_ascii, load_data, load_grouping, load_image, load_quality, pack_image, set_data, set_quality, ungroup, unpack_ascii, unpack_data, unpack_image
filtering
get_filter, load_filter, set_filter
info
get_default_id, list_data_ids, list_response_ids
modeling
clean, image_model, image_model_component, image_source, image_source_component
plotting
plot_data, set_xlinear, set_xlog, set_ylinear, set_ylog
psfs
image_kernel
saving
save_error, save_filter, save_grouping, save_quality, save_staterror, save_syserror
utilities
calc_data_sum, calc_data_sum2d, calc_ftest, calc_kcorr, calc_mlr, calc_model_sum2d, calc_source_sum2d, get_rate
visualization
contour, contour_data, contour_model, contour_ratio, contour_resid, histogram1d, histogram2d, image_close, image_deleteframes, image_fit, image_getregion, image_open, image_ratio, image_resid, image_setregion, image_xpaget, image_xpaset, rebin