get_source_component_image

sherpa.astro.ui.get_source_component_image(id, model=None, copy: bool = True) → sherpa.image.ComponentSourceImage

Return the data used by image_source_component.

Changed in version 4.19.0: The plot object is now copied by default. To get the previous behaviour set the copy attribute to False.

Parameters:

idint or str, optional

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

modelstr or sherpa.models.model.Model instance

The component to display (the name, if a string).

copybool, optional

Is the plot object copied before being returned? If so then the plot attributes will not be changed by multiple calls to this routine.

Returns:

cpt_imga sherpa.image.ComponentSourceImage instance

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

Raises:

sherpa.utils.err.IdentifierErr

If the data set does not exist or a source expression has not been set.

See also

get_model_component_image

Return the data used by image_model_component.

get_source_image

Return the data used by image_source.

image_source

Display the source expression for a data set in the image viewer.

image_source_component

Display a component of the source expression 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:

>>> sinfo = get_source_component_image(gsrc)

Get the ‘bgnd’ model pixel values for data set 2:

>>> sinfo = get_source_component_image(2, bgnd)