qis.regimes.get_regime_ids¶

qis.regimes.get_regime_ids(q=None, regime_ids=None)[source]¶

Ordered regime ids of a partition, from the lowest benchmark bucket up.

Parameters:

q (Sequence[float] | ndarray | None) – partition probabilities; None is the one-sigma cut
regime_ids (Sequence[str] | None) – explicit ids, one per bucket; None uses Bear, Normal, Bull for three buckets and Q1 to Qn otherwise

Returns:

the ids in bucket order

Raises:

ValueError – if regime_ids does not have one id per bucket

Return type:

List[str]