Last modified: December 2024

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


AHELP for CIAO 4.17 Sherpa

set_model_autoassign_func

Context: modeling

Synopsis

Set the method used to create model component identifiers.

Syntax

set_model_autoassign_func(func=None)

Description

When a model component is created, the default behavior is to add the component to the default Python namespace. This is controlled by a function which can be changed with this routine.


PARAMETERS

The parameter for this function is:

Parameter Type information Definition
func function reference The function to use: this should accept two arguments, a string (component name), and the model instance.

Notes

The default assignment function first renames a model component to include the model type and user-defined identifier. It then updates the '__main__' module's dictionary with the model identifier as the key and the model instance as the value. Similarly, it updates the '__builtin__' module's dictionary just like '__main__' for compatibility with IPython.


Bugs

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

See Also

data
get_bkg_chisqr_plot, get_bkg_delchi_plot, get_bkg_fit_plot, get_bkg_model_plot, get_bkg_plot, get_bkg_ratio_plot, get_bkg_resid_plot, get_bkg_source_plot
info
list_model_ids, show_bkg_model, show_bkg_source
modeling
add_model, add_user_pars, clean, create_model_component, delete_bkg_model, delete_model, delete_model_component, get_model, get_model_autoassign_func, get_model_component, get_model_component_image, get_model_component_plot, get_model_plot, get_num_par, get_num_par_frozen, get_num_par_thawed, get_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, get_source_contour, get_source_image, get_source_plot, image_model, image_model_component, image_source, image_source_component, integrate, link, load_table_model, load_template_interpolator, load_template_model, load_user_model, normal_sample, reset, save_model, save_source, set_bkg_model, set_bkg_source, set_full_model, set_model, set_pileup_model, set_source, t_sample, uniform_sample
plotting
get_cdf_plot, get_pdf_plot, get_pvalue_plot, get_pvalue_results, plot_cdf, plot_model, plot_model_component, plot_pdf, plot_pvalue, plot_scatter, plot_source, plot_source_component, plot_trace
psfs
delete_psf, load_conv
saving
save_delchi, save_resid
utilities
calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, calc_stat, eqwidth
visualization
contour_model, contour_ratio, contour_resid