API

API#

The abTEM API generally follows an object-oriented design with objects representing elements of the underlying physical models. Numpy-style docstrings embedded in the code allow the reference to be automatically generated.

abtem.antialias

Module for describing antialiasing objects.

abtem.array

Module for describing array objects.

abtem.atoms

Module for modifying ASE Atoms objects for use in abTEM.

abtem.waves

Module for describing wave functions of the incoming electron beam and the exit wave.

abtem.scan

Module for describing different types of scans.

abtem.detectors

Module for describing the detection of transmitted waves and different detector types.

abtem.measurements

Module for describing abTEM measurement objects.

abtem.transfer

Module to describe the contrast transfer function (CTF) and the related apertures.

abtem.transform

Module to describe wave function transformations.

abtem.parametrizations

Module for describing analytical potential parametrizations.

abtem.integrals

Module to describe projection integrals of radial potential parametrizations.

abtem.inelastic.phonons

Module to describe the effect of temperature on the atomic positions.

abtem.distributions

Module for describing distributions of simulation parameters.

abtem.potentials

Module to describe electrostatic potentials.

abtem.tilt

Module for simulating beam tilt.

abtem.visualize

abtem.multislice

Module for running the multislice algorithm.

abtem.prism

Module to describing scattering metrices used in the PRISM algorithm.