qis.regimes.get_regime_probabilities

qis.regimes.get_regime_probabilities(q=None, regime_ids=None)

Population probability of each bucket, the width of its probability interval.

A partition symmetric about the median gives its mirrored buckets exactly equal probabilities: 1 - 0.84 is not 0.16 in floating point, and the difference would otherwise leak into every mixture moment.

Parameters:

• q (Sequence[float] | ndarray | None) – partition probabilities; None is the one-sigma cut

• regime_ids (Sequence[str] | None) – ids of the buckets; None uses the defaults of get_regime_ids

Returns:

probability per regime id, summing to one

Return type:

Series