get_pileup_model¶

sherpa.astro.ui.get_pileup_model(id=None)¶

Return the pile up model for a data set.

Return the pile up model set by a call to set_pileup_model.

Parameters:	id (int or str, optional) – The data set containing the source expression. If not given then the default identifier is used, as returned by get_default_id.
Returns:	model
Return type:	a sherpa.astro.models.JDPileup instance
Raises:	`sherpa.utils.err.IdentifierErr` – If no pile up model has been set for the data set.

See also

fit(): Fit one or more data sets.
get_model(): Return the model expression for a data set.
get_source(): Return the source model expression for a data set.
sherpa.astro.models.JDPileup(): The ACIS pile up model.
set_pileup_model(): Include a model of the Chandra ACIS pile up when fitting PHA data.

Examples

>>> jdp1 = get_pileup_model()
>>> jdp2 = get_pileup_model(2)