image_model
- sherpa.ui.image_model(id=None, newframe=False, tile=False)
Display the model for a data set in the image viewer.
This function evaluates and displays the model expression for a data set, including any instrument response (e.g. PSF or ARF and RMF) whether created automatically or with
set_full_model
.The image viewer is automatically started if it is not already open.
- Parameters
id (int or str, optional) – The data set. If not given then the default identifier is used, as returned by
get_default_id
.newframe (bool, optional) – Create a new frame for the data? If
False
, the default, then the data will be displayed in the current frame.tile (bool, optional) – Should the frames be tiles? If
False
, the default, then only a single frame is displayed.
- Raises
sherpa.utils.err.IdentifierErr – If the data set does not exist or a source expression has not been set.
See also
get_model_image
Return the data used by image_model.
image_close
Close the image viewer.
image_fit
Display the data, model, and residuals for a data set in the image viewer.
image_model_component
Display a component of the model in the image viewer.
image_open
Open the image viewer.
image_source
Display the model for a data set in the image viewer.
image_source_component
Display a component of the source expression in the image viewer.
Notes
Image visualization is optional, and provided by the DS9 application.
Examples
Display the model for the default data set.
>>> image_model()
Display the model for 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_model(2, newframe=True)
Display the models for data sets ‘i1’ and ‘i2’ side by side:
>>> image_model('i1') >>> image_model('i2', newframe=True, tile=True)