AxisAlignedBeamTilt

class abtem.tilt.AxisAlignedBeamTilt(tilt=0.0, direction='x')

Bases: BaseBeamTilt

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')

Methods

__init__([tilt, direction])
apply(waves[, in_place])	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.
select_block(index, chunks)	Select a block from 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.
direction	Tilt direction.
ensemble_axes_metadata	Axes metadata describing the ensemble axes added to the waves when applying the transform.
ensemble_shape	The shape of the ensemble axes added to the waves when applying the transform.
metadata	Metadata added to the waves when applying the transform.
shape	Shape of the ensemble.
tilt	Beam tilt [mrad].

apply(waves, in_place=False)

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

Parameters:

• waves (Waves) – The waves to transform.

• in_place (bool, optional) – If True, the array representing the waves may be modified in-place.

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.

property direction: str

Tilt direction.

property ensemble_axes_metadata: list[AxisMetadata]

Axes metadata describing the ensemble axes added to the waves when applying the transform.

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

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.

property metadata

Metadata added to the waves when applying the transform.

select_block(index, chunks)

Select a block from the ensemble.

Parameters:

• index (tuple of ints) – Index of selected block.

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

property shape

Shape of the ensemble.

property tilt: float | BaseDistribution

Beam tilt [mrad].