DistributionFromValues

class abtem.distributions.DistributionFromValues(values, weights=None, ensemble_mean=False)

Bases: abtem.distributions.BaseDistribution

__init__(values, weights=None, ensemble_mean=False)

Methods

__init__(values[, weights, ensemble_mean])
combine(other)	Combine distribution with another distribution to produce a higher-dimensional distribution.
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.

combine(other)

Combine distribution with another distribution to produce a higher-dimensional distribution.

Parameters

other (DistributionFromValues) – The distribution to combine this distribution with.

Returns

combined_distribution – Higher-dimensional combined distribution.

Return type

MultidimensionalDistribution

copy()

Make a copy.

property dimensions: int

The number of dimensions in the distribution.

Return type

int

divide(chunks=1, lazy=True)

Divide the distribution into chunks.

property ensemble_mean: bool

Calculate the mean of the ensemble.

Return type

bool

property shape: tuple[int]

The shape of the distribution parameters.

Return type

tuple[int]

property values: numpy.ndarray

Scalar values representing the distribution.

Return type

ndarray

property weights: numpy.ndarray

Weight of each of distribution value.

Return type

ndarray