CompositeArrayObjectTransform

class abtem.transform.CompositeArrayObjectTransform(transforms=None)

Bases: ArrayObjectTransform

Combines multiple array object transformations into a single transformation.

Parameters:

transforms (ArrayObject) – The array object to transform.

__init__(transforms=None)

Methods

__init__([transforms])
apply(array_object)	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.
insert(transform, index)	Inserts an array object transform to the sequence of transforms before the specified index.
select_block(index, chunks)	Select a block from the ensemble.
set_output_specification(array_object)

Attributes

axes_metadata	List of AxisMetadata.
base_axes_metadata	List of AxisMetadata of the base axes.
base_shape	Shape of the base axes.
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.
transforms	The list of transforms in the composite.

apply(array_object)

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.

insert(transform, index)

Inserts an array object transform to the sequence of transforms before the specified index.

Parameters:

• transform (ArrayObjectTransform) – Array object transform to insert.

• index (int) – The array object transform is inserted before this index.

Returns:

composite_array_transform

Return type:

CompositeArrayObjectTransform

property metadata: dict

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 transforms: list[ArrayObjectTransform]

The list of transforms in the composite.