Histogram.uncertainties (function)

def uncertainties(self, sigma=1, tex=False, unit=None)

Expose (asymmetric) uncertainties for the distribution(s) at a given value of sigma.

This first determines the appropriate quantiles to pass to Histogram.ppf using scipy.state.norm.cdf([-sigma, 0, sigma]) and then formats those into a Latex friendly representation if tex is True.

Arguments

• sigma (int, optional, default=1): number of standard deviations to expose.
• tex (bool, optional, default=False): return as a formatted latex string.
• unit (astropy.unit, optional, default=None): unit of the values to expose. If None or not provided, will assume they're in Histogram.unit.

Returns

• if not tex: a list of triplets where each triplet is lower, median, upper
• if tex: Latex object with Latex.as_latex and Latex.as_string properties.