BaseSMatrix#
- class abtem.prism.s_matrix.BaseSMatrix[source]#
Bases:
BaseWaves
Base class for scattering matrices.
- __init__()#
Methods
__init__
()dummy_probes
([scan, ctf, plane])A probe or an ensemble of probes equivalent reducing the SMatrix at a single position.
match_grid
(other[, check_match])Match the grid to another object with a Grid.
Attributes
Accelerator object describing the acceleration energy.
Reciprocal-space sampling in units of scattering angles [mrad].
The number of grid points along the x and y direction in the simulation grid at the antialiasing cutoff scattering angle.
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.
List of AxisMetadata for the base axes in real space.
Scattering angles at the antialias cutoff [mrad].
The device where the S-Matrix is created and reduced.
The datatype of waves.
Electron acceleration energy in electron volts.
Extent of grid for each dimension in Ångstrom.
Scattering angles corresponding to the full wave function size [mrad].
Number of grid points for each dimension.
Simulation grid.
Interpolation factor in the x and y directions
Metadata stored as a dictionary.
List of AxisMetadata for base axes in reciprocal space.
Reciprocal-space sampling in reciprocal Ångstrom.
Scattering angles corresponding to the sides of the largest rectangle within the antialias cutoff [mrad].
Grid sampling for each dimension in Ångstrom per grid point.
The radial cutoff of the plane-wave expansion [mrad].
The wave vectors corresponding to each plane wave.
Relativistic wavelength in Ångstrom.
The cropping window extent of the waves.
The number of grid points describing the cropping window of the wave functions.
ensemble_axes_metadata
ensemble_shape
- property accelerator: Accelerator#
Accelerator object describing the acceleration energy.
- property angular_sampling: tuple[float, float]#
Reciprocal-space sampling in units of scattering angles [mrad].
- 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.
- 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.
- property base_axes_metadata: list[AxisMetadata]#
List of AxisMetadata for the base axes in real space.
- property cutoff_angles: tuple[float, float]#
Scattering angles at the antialias cutoff [mrad].
- property device#
The device where the S-Matrix is created and reduced.
- property dtype#
The datatype of waves.
- dummy_probes(scan=None, ctf=None, plane='entrance', **kwargs)[source]#
A probe or an ensemble of probes equivalent reducing the SMatrix at a single position.
- 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.
- property full_cutoff_angles: tuple[float, float]#
Scattering angles corresponding to the full wave function size [mrad].
- property gpts: tuple[int] | tuple[int, int] | tuple[int, ...]#
Number of grid points for each dimension.
- property grid: Grid#
Simulation grid.
- abstract property interpolation#
Interpolation factor in the x and y directions
- match_grid(other, check_match=False)#
Match the grid to another object with a Grid.
- abstract property metadata: dict#
Metadata stored as a dictionary.
- property reciprocal_space_axes_metadata: list[AxisMetadata]#
List of AxisMetadata for base axes in reciprocal space.
- property reciprocal_space_sampling: tuple[float] | tuple[float, float] | tuple[float, ...]#
Reciprocal-space sampling in reciprocal Ångstrom.
- property rectangle_cutoff_angles: tuple[float, float]#
Scattering angles corresponding to the sides of the largest rectangle within the antialias cutoff [mrad].
- property sampling: tuple[float] | tuple[float, float] | tuple[float, ...]#
Grid sampling for each dimension in Ångstrom per grid point.
- abstract property semiangle_cutoff: float#
The radial cutoff of the plane-wave expansion [mrad].
- abstract property wave_vectors: ndarray#
The wave vectors corresponding to each plane wave.
- property wavelength#
Relativistic wavelength in Ångstrom.
- abstract property window_extent#
The cropping window extent of the waves.
- abstract property window_gpts#
The number of grid points describing the cropping window of the wave functions.