BaseWaves#

class abtem.waves.BaseWaves[source]#

Bases: abtem.core.grid.HasGridMixin, abtem.core.energy.HasAcceleratorMixin

Base class of all wave functions. Documented in the subclasses.

__init__()#

Methods

`__init__`()
`match_grid`(other[, check_match])	Match the grid to another object with a Grid.

Attributes

`accelerator`	Accelerator object describing the acceleration energy.
`angular_sampling`	Reciprocal-space sampling in units of scattering angles [mrad].
`antialias_cutoff_gpts`	The number of grid points along the x and y direction in the simulation grid at the antialiasing cutoff scattering angle.
`antialias_valid_gpts`	The number of grid points along the x and y direction in the simulation grid for the largest rectangle that fits within antialiasing cutoff scattering angle.
`base_axes_metadata`	List of AxisMetadata for the base axes in real space.
`cutoff_angles`	Scattering angles at the antialias cutoff [mrad].
`device`	The device where the waves are built or stored.
`dtype`	The datatype of waves.
`energy`	Electron acceleration energy in electron volts.
`extent`	Extent of grid for each dimension in Ångstrom.
`full_cutoff_angles`	Scattering angles corresponding to the full wave function size [mrad].
`gpts`	Number of grid points for each dimension.
`grid`	Simulation grid.
`metadata`	Metadata stored as a dictionary.
`reciprocal_space_axes_metadata`	List of AxisMetadata for base axes in reciprocal space.
`reciprocal_space_sampling`	Reciprocal-space sampling in reciprocal Ångstrom.
`rectangle_cutoff_angles`	Scattering angles corresponding to the sides of the largest rectangle within the antialias cutoff [mrad].
`sampling`	Grid sampling for each dimension in Ångstrom per grid point.
`wavelength`	Relativistic wavelength in Ångstrom.

property accelerator: abtem.core.energy.Accelerator#

Accelerator object describing the acceleration energy.

Return type: Accelerator

property angular_sampling: tuple[float, float]#

Reciprocal-space sampling in units of scattering angles [mrad].

Return type: tuple[float, float]

property antialias_cutoff_gpts: tuple[int, int]#

The number of grid points along the x and y direction in the simulation grid at the antialiasing cutoff scattering angle.

Return type: tuple[int, int]

property antialias_valid_gpts: tuple[int, int]#

The number of grid points along the x and y direction in the simulation grid for the largest rectangle that fits within antialiasing cutoff scattering angle.

Return type: tuple[int, int]

property base_axes_metadata: list[abtem.core.axes.AxisMetadata]#

List of AxisMetadata for the base axes in real space.

Return type: list[AxisMetadata]

property cutoff_angles: tuple[float, float]#

Scattering angles at the antialias cutoff [mrad].

Return type: tuple[float, float]

abstract property device#: The device where the waves are built or stored.

property dtype#: The datatype of waves.

property energy#: Electron acceleration energy in electron volts.

property extent: tuple[float] | tuple[float, float] | tuple[float, ...]#

Extent of grid for each dimension in Ångstrom.

Return type: tuple[float] | tuple[float, float] | tuple[float, …]

property full_cutoff_angles: tuple[float, float]#

Scattering angles corresponding to the full wave function size [mrad].

Return type: tuple[float, float]

property gpts: tuple[int] | tuple[int, int] | tuple[int, ...]#

Number of grid points for each dimension.

Return type: tuple[int] | tuple[int, int] | tuple[int, …]

property grid: abtem.core.grid.Grid#

Simulation grid.

Return type: Grid

match_grid(other, check_match=False)#: Match the grid to another object with a Grid.

abstract property metadata: dict#

Metadata stored as a dictionary.

Return type: dict

property reciprocal_space_axes_metadata: list[abtem.core.axes.AxisMetadata]#

List of AxisMetadata for base axes in reciprocal space.

Return type: list[AxisMetadata]

property reciprocal_space_sampling: tuple[float] | tuple[float, float] | tuple[float, ...]#

Reciprocal-space sampling in reciprocal Ångstrom.

Return type: tuple[float] | tuple[float, float] | tuple[float, …]

property rectangle_cutoff_angles: tuple[float, float]#

Scattering angles corresponding to the sides of the largest rectangle within the antialias cutoff [mrad].

Return type: tuple[float, float]

property sampling: tuple[float] | tuple[float, float] | tuple[float, ...]#

Grid sampling for each dimension in Ångstrom per grid point.

Return type: tuple[float] | tuple[float, float] | tuple[float, …]

property wavelength#: Relativistic wavelength in Ångstrom.