BeamTilt

class abtem.tilt.BeamTilt(tilt)

Bases: BaseBeamTilt

Class describing beam tilt.

Parameters:

tilt (tuple of float) – Tilt along the x and y axes [mrad] with an optional spread of values.

__init__(tilt)

Methods

__init__(tilt)
apply(waves[, max_batch])	Apply tilt(s) to (an ensemble of) wave function(s).
copy()	Make a copy.
ensemble_blocks([chunks])	Split the ensemble into an array of smaller ensembles.
generate_blocks([chunks])	Generate chunks of the ensemble.

Attributes

axes_metadata	List of AxisMetadata.
base_axes_metadata	List of AxisMetadata of the base axes.
base_shape	Shape of the base axes.
distributions
ensemble_axes_metadata	Metadata describing (an ensemble of) tilted wave function(s).
ensemble_shape	The shape of the ensemble axes added to the waves when applying the transform.
metadata	Metadata describing the tilt.
shape	Shape of the ensemble.
tilt	Beam tilt angle [mrad].

apply(waves, max_batch='auto')

Apply tilt(s) to (an ensemble of) wave function(s).

Parameters:

• waves (Waves) – The wave function(s) to apply the tilt to.

• max_batch (int or str, optional) – The maximum batch size used in the calculation. If ‘auto’, the batch size is automatically determined. Default is ‘auto’.

Returns:

waves_with_tilt

Return type:

Waves

property axes_metadata: AxesMetadataList

List of AxisMetadata.

property base_axes_metadata: list[AxisMetadata]

List of AxisMetadata of the base axes.

property base_shape: tuple[int, ...]

Shape of the base axes.

copy()

Make a copy.

Return type:

Self

property ensemble_axes_metadata: list[AxisMetadata]

Metadata describing (an ensemble of) tilted wave function(s).

ensemble_blocks(chunks=None)

Split the ensemble into an array of smaller ensembles.

Parameters:

chunks (iterable of tuples) – Block sizes along each dimension.

Return type:

Array

property ensemble_shape: tuple[int, ...]

The shape of the ensemble axes added to the waves when applying the transform.

generate_blocks(chunks=1)

Generate chunks of the ensemble.

Parameters:

chunks (iterable of tuples) – Block sizes along each dimension.

Return type:

Generator[tuple[tuple[int, ...], tuple[slice, ...], ndarray], None, None]

property metadata

Metadata describing the tilt.

property shape: tuple[int, ...]

Shape of the ensemble.

property tilt: tuple[float, float] | BaseDistribution

Beam tilt angle [mrad].