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

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


AHELP for CIAO 4.6 Sherpa v2

get_method

Context: methods

Synopsis

Return information on the optimization method

Syntax

get_method( [name] )
get_method_opt( [optname] )
get_method_name()

Description

The get_method commands return information about the optimization methods:

  • get_method - a reference to an object containing the requested optimization method, including name and options. If unspecified, the current method is returned.
  • get_method_opt - the value of the requested option for the current optimization method. If unspecified, a dictionary of all options for the method are returned. Refer to the ahelp file for each method for a complete description of the options, e.g. "ahelp levmar".
  • get_method_name - the name of the current optimization method.

Available statistics are returned by the list_methods command ("ahelp list_methods").

Example 1

sherpa> print(get_method_name())
levmar
sherpa> print(get_method())

Get the name of the current optimization method, the get retrieve the method and print it to the screen. The output for this example is:

name    = levmar
ftol    = 1.19209289551e-07
xtol    = 1.19209289551e-07
gtol    = 1.19209289551e-07
maxfev  = None
epsfcn  = 1.19209289551e-07
factor  = 100.0
verbose = 0

Example 2

sherpa> print(get_method("neldermead"))

Print the neldermead method.

Example 3

sherpa> set_method("simplex")
sherpa> simopt=get_method_opt()
sherpa> get_method_opt("scale")
3.0

Set the method to simplex, then retrieve all the options for that method. Finally, retrieve the value of the scale, which is 3.0.

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, get_fit, get_stat_info
info
get_default_id, list_stats
methods
get_draws, get_iter_method_name, get_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
psfs
get_kernel, get_psf
statistics
get_chisqr_plot, get_delchi_plot, get_prior, get_sampler, get_stat
utilities
get_analysis, get_rate
visualization
get_ratio, get_resid, 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.