bilby.core.utils.samples.SamplesSummary

class bilby.core.utils.samples.SamplesSummary(samples, average='median', confidence_level=0.9)

Bases: object

Object to store a set of samples and calculate summary statistics

Parameters:

samples: array_like

Array of samples

average: str {‘median’, ‘mean’}

Use either a median average or mean average when calculating relative uncertainties

level: float

The default confidence interval level, defaults t0 0.9

__init__(samples, average='median', confidence_level=0.9)

__call__(*args, **kwargs)

Call self as a function.

Methods

__init__(samples[, average, confidence_level])

Attributes

average
confidence_level
lower_absolute_credible_interval	Absolute lower value of the credible interval
lower_relative_credible_interval	Relative (to average) lower value of the credible interval
mean
median
samples
upper_absolute_credible_interval	Absolute upper value of the credible interval
upper_relative_credible_interval	Relative (to average) upper value of the credible interval

property lower_absolute_credible_interval

Absolute lower value of the credible interval

property lower_relative_credible_interval

Relative (to average) lower value of the credible interval

property upper_absolute_credible_interval

Absolute upper value of the credible interval

property upper_relative_credible_interval

Relative (to average) upper value of the credible interval