ReciprocalSpaceMultiplication

ReciprocalSpaceMultiplication#

class abtem.transform.ReciprocalSpaceMultiplication(in_place=False, distributions=())[source]#

Wave function transformation for multiplying each member of an ensemble of wave functions with an array.

Parameters:

in_place (bool, optional) – If True, the array representing the waves may be modified in-place.
distributions (tuple of str, optional) – Names of properties that may be described by a distribution.

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.
`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.
`metadata`	Metadata added to the waves when applying the transform.
`shape`	Shape of the ensemble.

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 base_axes_metadata: list[AxisMetadata]#: List of AxisMetadata of the base axes.

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 in_place: bool#: The array representing the waves may be modified in-place.

property metadata: dict#: Metadata added to the waves when applying the transform.

select_block(index, chunks)#

Select a block from the ensemble.

Parameters: