Chandra X-Ray Observatory
	(CXC)
Skip to the navigation links
Last modified: December 2015

URL: http://cxc.harvard.edu/sherpa/ahelp/calc_stat.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.9 Sherpa v1

calc_stat

Context: utilities

Synopsis

Calculate the fit statistic by data set ID

Syntax

calc_stat( [ id, [otherids]] )

Description

The function calc_stat returns the value of the fit statistic for the data set ID(s) specified; the data set ID(s) supplied to calc_stat must be ready for fitting, i.e. it has been assigned a model to be fit. The calc_stat function can be called with no arguments, in which case the fit statistic for the default data set ready for fitting will be returned. If multiple data set IDs are given, then the simultaneous fit statistic is calculated for those data sets. The fit statistic value returned by calc_stat represents the initial fit statistic, which matches the "istatval" value returned by get_fit_results.

  • id, otherids - the id(s) of the dataset(s) to use; if not given, uses the default dataset id (id=1 by default, see "ahelp get_default_id"); otherids=None

The fit statistics available in Sherpa are described in ahelp list_stats.

Example 1

sherpa> calc_stat()

When called with no arguments, calc_stat() returns the fit statistic for the default data set, if it has been assigned a model to be fit.

Example 2

sherpa> calc_stat(1)
sherpa> calc_stat("src")

Supplying a specific data set ID to calc_stat - such as "1" or a the string "src" - will return the initial fit statistic for only that data set.

Example 3

sherpa> calc_stat(1,2)
sherpa> calc_stat("src", "bkg")

When supplied with multiple data set IDs, calc_stat returns the intial fit statistic produced by the simultaneous fit on those data sets.

Bugs

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

See Also

data
get_bkg_plot
fitting
fit
info
list_model_ids, show_bkg_model, show_bkg_source
methods
get_iter_method_name, get_iter_method_opt, list_iter_methods, set_iter_method, set_iter_method_opt
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_order_plot, get_par, get_pileup_model, get_source, get_source_component_image, get_source_component_plot, image_model, image_model_component, image_source, image_source_component, integrate, integrate1d, link, load_table_model, load_template_model, load_user_model, normal_sample, reset, save_model, save_source, set_bkg_model, set_full_model, set_model_autoassign_func, set_pileup_model, set_source, set_xsabund, set_xscosmo, set_xsxsect, set_xsxset, t_sample, uniform_sample
plotting
get_lrt_plot, get_lrt_results, get_pvalue_plot, get_pvalue_results, plot_cdf, plot_fit, 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
statistics
get_stat
tools
aprates, modelflux
utilities
calc_chisqr, calc_energy_flux, calc_model_sum, calc_photon_flux, calc_source_sum, eqwidth, gamma, igam, igamc, incbet, lgam
visualization
contour_model, contour_ratio, contour_resid, get_ratio, get_resid, image_fit

Last modified: December 2015
Smithsonian Institute Smithsonian Institute

The Chandra X-Ray Center (CXC) is operated for NASA by the Smithsonian Astrophysical Observatory. 60 Garden Street, Cambridge, MA 02138 USA.   Email:   cxchelp@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.