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

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


AHELP for CIAO 4.6 Sherpa v1

get_stat

Context: statistics

Synopsis

Return information on the fit statistic

Syntax

get_stat([name])
get_stat_name()

Description

The get_stat command returns a descriptive string about the specified fit statistic. It takes one argument:

  • name - the name of the fit statistic to return; default is the current fit statistic.

The get_stat_name command returns the name of the current fit statistic.

To print the current statistic to the screen, use the show_stat command ("ahelp show_stat").

Example 1

sherpa> get_stat("chi2datavar")

Return information on the statistic "chi2datavar"; the output is:

Chi Squared with data variance

Example 2

sherpa> set_stat("chi2gehrels")
sherpa> get_stat()
Chi Squared with Gehrels variance
sherpa> get_stat_name()
'chi2gehrels'

Set the statistic to "chi2gehrels", then return information and the name of the current statistic.

Bugs

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

See Also

confidence
get_conf, get_covar, get_int_proj, get_int_unc, get_proj, get_reg_proj, get_reg_unc
contrib
get_chart_spectrum
data
get_areascal, get_arf, get_arf_plot, get_axes, get_backscal, get_bkg, get_bkg_plot, get_bkg_scale, get_coord, get_counts, get_data, get_data_plot, get_dep, get_dims, get_error, get_exposure, get_grouping, get_indep, get_quality, get_rmf, get_specresp, get_staterror, get_syserror
filtering
get_filter
fitting
calc_stat_info, fit, get_fit, get_stat_info
info
get_default_id, list_stats
methods
get_draws, get_iter_method_name, get_iter_method_opt, get_method, list_iter_methods, set_iter_method, set_iter_method_opt
modeling
get_model, 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_response, get_source, get_source_component_image, get_source_component_plot, image_source
plotting
get_split_plot, plot_fit
psfs
get_kernel, get_psf
statistics
get_chisqr_plot, get_delchi_plot, get_prior, get_sampler
utilities
calc_chisqr, calc_stat, get_analysis, get_rate
visualization
contour_resid, get_ratio, get_resid, image_fit, image_getregion

Last modified: December 2013
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:   cxcweb@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2014. All rights reserved.