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").

Examples

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.