Skip to content

Xspec

parallel_folding(params, indexes, model_indexes, desc='', progress_bar=True, pool=None, return_kind='cstat')

Evaluate folded xspec outputs for a batch of parameter vectors.

Parameters:

Name Type Description Default
params

Parameter vectors to evaluate.

required
indexes

xspec parameter indices associated with params.

required
model_indexes

xspec model names associated with indexes.

required
desc

Prefix for the progress-bar label.

''
progress_bar

Whether to display a tqdm progress bar.

True
pool

Optional process pool for parallel evaluation.

None
return_kind

One of "cstat", "full_model_counts", or "models_and_components".

'cstat'

Returns:

Type Description

Stacked outputs across all rows in params. The "cstat" key is always present. "total_model_counts" is included for "full_model_counts" and "models_and_components". "model_counts" and "component_counts" are included only for "models_and_components".