BaseScan

class abtem.scan.BaseScan(in_place=False, distributions=())

Bases: ReciprocalSpaceMultiplication

Abstract class to describe scans.

__init__(in_place=False, distributions=())

Methods

__init__([in_place, distributions])
apply(waves)	Apply the transform to the given waves.
copy()	Make a copy.
ensemble_blocks([chunks])	Split the ensemble into an array of smaller ensembles.
generate_blocks([chunks])	Generate chunks of the ensemble.
get_positions(*args, **kwargs)	Get the scan positions as numpy array.
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.
distributions
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.
in_place	The array representing the waves may be modified in-place.
limits	Lower left and upper right corner of the bounding box containing all positions in the scan.
metadata	Metadata added to the waves when applying the transform.
num_positions	Number of probe positions in the scan.
shape	The shape the scan.

apply(waves)

Apply the transform to the given waves.

Parameters:

array_object (ArrayObject) – The array object to transform.

Returns:

transformed_array_object

Return type:

ArrayObject

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 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: 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.

abstract get_positions(*args, **kwargs)

Get the scan positions as numpy array.

Return type:

ndarray

property in_place: bool

The array representing the waves may be modified in-place.

abstract property limits

Lower left and upper right corner of the bounding box containing all positions in the scan.

property metadata: dict

Metadata added to the waves when applying the transform.

property num_positions: int

Number of probe positions in the scan.

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.

abstract property shape: tuple[int, ...]

The shape the scan.