class QuantityStatistics¶

class deeptime.util.QuantityStatistics(samples: List[ndarray], quantity, confidence=0.95, store_samples=False)¶

Container for statistical quantities computed on samples.

Parameters:

samples (list of ndarrays) – the samples
store_samples (bool, default=False) – whether to store the samples (array).

Attributes

`L`	Element-wise lower bounds.
`R`	Element-wise upper bounds.
`mean`	Mean along axis=0
`std`	Standard deviation along axis=0.

Methods

gather(samples[, quantity, store_samples, ...])

Obtain statistics about a sampled quantity.

static gather(samples, quantity=None, store_samples=False, delimiter='/', confidence: float = 0.95, *args, **kwargs)¶

Obtain statistics about a sampled quantity. Can also be a chained call, separated by the delimiter.

Parameters:

samples (list of object) – The samples which contain sought after quantities.
quantity (str, optional, default=None) – Name of attribute, which will be evaluated on samples. If None, no quantity is evaluated and the samples are assumed to already be the quantity that is to be evaluated.
store_samples (bool, optional, default=False) – Whether to store the samples (array).
delimiter (str, optional, default='/') – Separator to call members of members.
confidence (float, optional, default=0.95) – Confidence parameter for the confidence intervals.
*args – pass through
**kwargs – pass through

Returns:

statistics – The collected statistics.

Return type:

QuantityStatistics

property L¶

Element-wise lower bounds.

property R¶

Element-wise upper bounds.

property mean¶

Mean along axis=0

property std¶

Standard deviation along axis=0.