BaseDistribution

class abtem.distributions.BaseDistribution

Bases: EqualityMixin, CopyMixin

Base object for defining distributions of simulation parameters.

__init__()

Methods

__init__()
copy()	Make a copy.
divide([chunks, lazy])	Divide the distribution into chunks.

Attributes

dimensions	The number of dimensions in the distribution.
ensemble_mean	Calculate the mean of the ensemble.
shape	The shape of the distribution parameters.
values	Scalar values representing the distribution.
weights	Weight of each of distribution value.

copy()

Make a copy.

Return type:

Self

abstract property dimensions: int

The number of dimensions in the distribution.

abstract divide(chunks=1, lazy=True)

Divide the distribution into chunks.

Return type:

Union[ndarray, Array]

abstract property ensemble_mean: bool

Calculate the mean of the ensemble.

abstract property shape: tuple[int, ...]

The shape of the distribution parameters.

abstract property values: ndarray

Scalar values representing the distribution.

abstract property weights: ndarray

Weight of each of distribution value.