get_model_component_image

sherpa.ui.get_model_component_image(id, model=None)

Return the data used by image_model_component.

Parameters:

id (int or str, optional) – The data set. If not given then the default identifier is used, as returned by get_default_id.
model (str or sherpa.models.model.Model instance) – The component to display (the name, if a string).

Returns:

cpt_img – The y attribute contains the component model values as a 2D NumPy array.

Return type:

a sherpa.image.ComponentModelImage instance

Raises:

sherpa.utils.err.IdentifierErr – If the data set does not exist or a source expression has not been set.

See also

get_source_component_image: Return the data used by image_source_component.
get_model_image: Return the data used by image_model.
image_model: Display the model for a data set in the image viewer.
image_model_component: Display a component of the model in the image viewer.

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 model parameter. If given two un-named arguments, then they are interpreted as the id and model parameters, respectively.

Examples

Return the gsrc component values for the default data set:

>>> minfo = get_model_component_image(gsrc)

Get the bgnd model pixel values for data set 2:

>>> minfo = get_model_component_image(2, bgnd)