delete_bkg_model

sherpa.astro.ui.delete_bkg_model(id=None, bkg_id=None)

Delete the background model expression for a data set.

This removes the model expression, created by set_bkg_model, for the background component of a data set. It does not delete the components of the expression, or remove the models for any other background components or the source of the data set.

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.
• bkg_id (int or string, optional) – The identifier for the background component to use.

See also

clean()

Clear all stored session data.

delete_model()

Delete the model expression for a data set.

get_default_id()

Return the default data set identifier.

list_bkg_ids()

List all the background identifiers for a data set.

set_model()

Set the source model expression for a data set.

show_model()

Display the source model expression for a data set.

Examples

Remove the background model expression for the default data set:

>>> delete_bkg_model()

Remove the model expression for the background component labelled ‘down’ for the data set with the identifier ‘src’:

>>> delete_bkg_model('src', 'down')