get_covar_opt

sherpa.astro.ui.get_covar_opt(name=None)

Return one or all of the options for the covariance method.

This is a helper function since the options can also be read directly using the object returned by get_covar.

Parameters:name (str, optional) – If not given, a dictionary of all the options are returned. When given, the individual value is returned.
Returns:value
Return type:dictionary or value
Raises:sherpa.utils.err.ArgumentErr – If the name argument is not recognized.

See also

covar()
Estimate confidence intervals using the covariance method.
get_covar()
Return the covariance estimation object.
set_covar_opt()
Set an option of the covar estimation object.

Examples

>>> get_covar_opt('sigma')
1
>>> copts = get_covar_opt()
>>> copts['sigma']
1