get_xsxset

sherpa.astro.xspec.get_xsxset(name: str) str[source] [edit on github]

Return the X-Spec model setting.

Parameters:

name (str) – The name of the setting (converted to upper case before being sent to X-Spec). There is no check that the name is valid.

Returns:

val – Returns the value set by a previous call to set_xsxset or the empty string, if the value has not been previously set.

Return type:

str

See also

set_xsxset

Notes

Due to the way X-Spec model settings work, get_xsxset will only return a value if it has previously been set with a call to set_xsxset. There is no way to retrieve the default value of a setting.

Examples

>>> set_xsxset("POW_EMIN", "0.5")
>>> get_xsxset("pow_emin")
'0.5'