AxisAlignedBeamTilt#

class abtem.tilt.AxisAlignedBeamTilt(tilt=0.0, direction='x')[source]#

Bases: DistributionFromValues

Class describing tilt(s) aligned with an axis.

Parameters:
  • tilt (array of BeamTilt) – Tilt along the given direction with an optional spread of values.

  • direction (str) – Cartesian axis, should be either ‘x’ or ‘y’.

__init__(tilt=0.0, direction='x')[source]#

Methods

__init__([tilt, direction])

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.

direction

Tilt direction.

ensemble_axes_metadata

ensemble_mean

Calculate the mean of the ensemble.

metadata

shape

The shape of the distribution parameters.

tilt

Beam tilt [mrad].

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.

Return type:

Self

property dimensions: int#

The number of dimensions in the distribution.

property direction: str#

Tilt direction.

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 tilt: float | BaseDistribution#

Beam tilt [mrad].

property values: ndarray#

Scalar values representing the distribution.

property weights: ndarray#

Weight of each of distribution value.