Last modified: December 2020

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


AHELP for CIAO 4.13 Sherpa v1

get_model_image

Context: visualization

Synopsis

Return the data used by image_model.

Syntax

get_model_image(id=None)

id - int or str, optional

Description

Evaluate the source expression for the image pixels - including any PSF convolution defined by `set_psf` - and return the results.


Example

Calculate the residuals (data - model) for the default data set:

>>> minfo = get_model_image()
>>> dinfo = get_data_image()
>>> resid = dinfo.y - minfo.y

PARAMETERS

The parameter for this function is:

Parameter Definition
id The data set. If not given then the default identifier is used, as returned by `get_default_id` .

Return value

The return value from this function is:

src_img -- The y attribute contains the source model values as a 2D NumPy array.


Bugs

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

See Also

modeling
get_source_image, image_model