ProjectionIntegratorPlan#

class abtem.integrals.ProjectionIntegratorPlan(periodic, finite)[source]#

Bases: abtem.core.utils.EqualityMixin, abtem.core.utils.CopyMixin

The ProjectionIntegratorPlan facilitates the creation of ProjectionIntegrator objects using the .build method given a grid and a chemical symbol.

Parameters

  • periodic (bool) – True indicates that the projection integrals are periodic perpendicular to the projection direction.

  • finite (bool) – True indicates that the projection integrals are finite along the projection direction.

__init__(periodic, finite)[source]#

Methods

__init__(periodic, finite)

build(symbol, gpts, sampling, device)

Build projection integrator for given chemical symbol, grid and device.

copy()

Make a copy.

cutoff(symbol)

Radial cutoff of the potential for the given chemical symbol.

Attributes

finite

True indicates that the created projection integrators are implemented only for infinite potential projections.

periodic

True indicates that the created projection integrators are implemented only for periodic potentials.
abstract build(symbol, gpts, sampling, device)[source]#

Build projection integrator for given chemical symbol, grid and device.

Parameters

  • symbol (str) – Chemical symbol to build the projection integrator for.

  • gpts (two int) – Number of grid points in x and y describing each slice of the potential.

  • sampling (two float) – Sampling of the potential in x and y [1 / Å].

  • device (str, optional) – The device used for calculating the potential, ‘cpu’ or ‘gpu’. The default is determined by the user configuration file.

Returns

projection_integrator – The projection integrator for the specified chemical symbol.

Return type

ProjectionIntegrator

copy()#

Make a copy.

abstract cutoff(symbol)[source]#

Radial cutoff of the potential for the given chemical symbol.

Return type

float

property finite: bool#

True indicates that the created projection integrators are implemented only for infinite potential projections.

Return type

bool

property periodic: bool#

True indicates that the created projection integrators are implemented only for periodic potentials.

Return type

bool