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

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


AHELP for CIAO 4.9 Sherpa v1

list_samplers

Context: statistics

Synopsis

List all available pyBLoCXS samplers.

Syntax

list_samplers()

Description

The Sherpa list_samplers command returns the list of available samplers, or jumping rules, available for use in the pyBLoCXS algorithm.

pyBLoCXS is a sophisticated Markov chain Monte Carlo (MCMC) based algorithm designed to carry out Bayesian Low-Count X-ray Spectral (BLoCXS) analysis in the Sherpa environment. The algorithm explores parameter space at a suspected minimum - i.e. after a standard Sherpa fit.

Jumping Rules

"MH" is Metropolis-Hastings, which always jumps from the best-fit, and "MetropolisMH" is Metropolis with Metropolis-Hastings that jumps from the best-fit with probability 'p_M', else it jumps from the last accepted jump. "PragBayes" is used when effective area calibration uncertainty is to be included in the calculation. (At each nominal MCMC iteration, a new calibration product is generated, and a series of N (option in set_sampler_opt) MCMC sub-iteration steps are carried out, choosing between Metropolis and Metropolis-Hastings types of samplers with probability p_M (option in set_sampler_opt). Only the last of these sub-iterations are kept in the chain.)

The get_sampler* and set_sampler* functions are available for accessing and modifying the attributes of each sampler type; see the corresponding ahelp files for details (e.g., "ahelp get_sampler").

Refer to the pyBLoCXS documentation for additional information about the algorithm.

Example

sherpa> list_samplers()

Return the names of the available jumping rules for use in the algorithm.

sherpa> list_samplers()
['MetropolisMH', 'MH', 'PragBayes']

Bugs

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

See Also

info
list_functions, list_response_ids
methods
list_iter_methods, list_methods
models
list_model_components, list_models
statistics
list_priors

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:   cxchelp@head.cfa.harvard.edu Smithsonian Institution, Copyright © 1998-2017. All rights reserved.