MultidimensionalDistribution

class abtem.distributions.MultidimensionalDistribution(distributions)

Bases: BaseDistribution

A multidimensional distribution composed of multiple lower-dimensional distributions.

Parameters:

distributions (list of BaseDistribution) – The lower-dimensional distributions composed into a higher-dimensional distribution.

__init__(distributions)

Methods

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

Attributes

dimensions	The number of dimensions in the distribution.
distributions	The lower dimensional distributions making up this 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

property dimensions: int

The number of dimensions in the distribution.

property distributions

The lower dimensional distributions making up this distribution.

divide(chunks=1, lazy=True)

Divide the distribution into chunks.

Return type:

Union[ndarray, Array]

property ensemble_mean: bool

Calculate the mean of the ensemble.

property shape: tuple[int, ...]

The shape of the distribution parameters.

property values: ndarray

Scalar values representing the distribution.

property weights: ndarray

Weight of each of distribution value.