abtem.transform

`abtem.transform`#

Module to describe wave function transformations.

Module Contents#

Classes#

`ArrayObjectTransform`
`EmptyTransform`
`EnsembleTransform`
`ReciprocalSpaceMultiplication`	Wave function transformation for multiplying each member of an ensemble of wave functions with an array.
`TransformFromFunc`
`WavesToMeasurementTransform`
`WavesToWavesTransform`
`WavesTransform`

Functions#

join_tuples

Data#

WavesType

API#

class abtem.transform.ArrayObjectTransform[source]#

Bases: typing.Generic[abtem.array.ArrayObjectType, abtem.array.ArrayObjectTypeAlt], abtem.core.ensemble.Ensemble, abtem.core.utils.EqualityMixin, abtem.core.utils.CopyMixin

abstract apply(...) → abtem.array.ArrayObjectType | abtem.array.ArrayObjectTypeAlt | list[abtem.array.ArrayObjectType | abtem.array.ArrayObjectTypeAlt][source]#

property ensemble_axes_metadata: list[AxisMetadata]#: Axes metadata describing the ensemble axes added to the waves when applying the transform.

property ensemble_shape: tuple[int, ...]#: The shape of the ensemble axes added to the waves when applying the transform.

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

class abtem.transform.EmptyTransform[source]#

Bases: abtem.core.ensemble.EmptyEnsemble, abtem.transform.ArrayObjectTransform[abtem.array.ArrayObject, abtem.array.ArrayObject]

apply(...) → ArrayObject[source]#

class abtem.transform.EnsembleTransform(...)[source]#: Bases: abtem.distributions.EnsembleFromDistributions, abtem.transform.ArrayObjectTransform[abtem.array.ArrayObjectType, abtem.array.ArrayObjectTypeAlt]

class abtem.transform.ReciprocalSpaceMultiplication(...)[source]#

Bases: abtem.transform.WavesToWavesTransform

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.

Initialization

property in_place: bool#: The array representing the waves may be modified in-place.

class abtem.transform.TransformFromFunc(...)[source]#

Bases: abtem.transform.ArrayObjectTransform[abtem.array.ArrayObject, abtem.array.ArrayObject]

Initialization

apply(...) → abtem.array.ArrayObjectType[source]#

property ensemble_shape: tuple[int, ...]#

property func#

property func_kwargs#

class abtem.transform.WavesToMeasurementTransform(...)[source]#

Bases: abtem.transform.WavesTransform[abtem.measurements.BaseMeasurements]

apply(...) → Waves | BaseMeasurements | list[Waves | BaseMeasurements][source]#

class abtem.transform.WavesToWavesTransform(...)[source]#

Bases: abtem.transform.WavesTransform

apply(...) → Waves[source]#

class abtem.transform.WavesTransform(...)[source]#

Bases: abtem.transform.EnsembleTransform[abtem.waves.Waves, abtem.array.ArrayObjectType]

abstract apply(...) → Waves | abtem.array.ArrayObjectType | list[Waves | abtem.array.ArrayObjectType][source]#

property distributions: tuple[str, ...]#

abtem.transform.WavesType#: ‘TypeVar(…)’

abtem.transform.join_tuples(...) → tuple[Any, ...][source]#