abtem.magnetism.iam

abtem.magnetism.iam#

Module Contents#

Classes#

BaseMagneticField

BaseVectorPotential

MagneticField

MagneticFieldArray

QuasiDipoleMagneticFieldProjections

QuasiDipoleProjections

QuasiDipoleVectorPotentialProjections

VectorPotential

VectorPotentialArray

Functions#

atomic_magnetic_field_3d

atomic_vector_potential_3d

bilinear_weighted_sum

cartesian2polar_3d

index_mask

interpolate

interpolate_quasi_dipole_field_projections

interpolate_quasi_dipole_vector_field_projections

magnetic_field_3d

radial_cutoff

radial_prefactor_a

radial_prefactor_b1

radial_prefactor_b2

rotate_points_2d

symmetric_arange

unit_vector_from_angles

vector_potential_3d

Data#

CUTOFF

API#

class abtem.magnetism.iam.BaseMagneticField[source]#

Bases: abtem.potentials.iam.BaseField

property base_axes_metadata#

List of AxisMetadata for the base axes.

property base_shape#

Shape of the base axes of the potential.

class abtem.magnetism.iam.BaseVectorPotential[source]#

Bases: abtem.potentials.iam.BaseField

property base_axes_metadata#

List of AxisMetadata for the base axes.

property base_shape#

Shape of the base axes of the potential.

abtem.magnetism.iam.CUTOFF#

4.25

class abtem.magnetism.iam.MagneticField(...)[source]#

Bases: abtem.potentials.iam._FieldBuilderFromAtoms, abtem.magnetism.iam.BaseMagneticField

Initialization

class abtem.magnetism.iam.MagneticFieldArray(...)[source]#

Bases: abtem.magnetism.iam.BaseMagneticField, abtem.potentials.iam.FieldArray

abstract classmethod from_array_and_metadata(...) → MagneticFieldArray[source]#
class abtem.magnetism.iam.QuasiDipoleMagneticFieldProjections(...)[source]#

Bases: abtem.magnetism.iam.QuasiDipoleProjections

Initialization

class abtem.magnetism.iam.QuasiDipoleProjections(...)[source]#

Initialization

cutoff(...)[source]#
property finite#
get_integral_table(...)[source]#
integrate_on_grid(...)[source]#
property parametrization#
property periodic#
property sampling#
property slice_thickness#
class abtem.magnetism.iam.QuasiDipoleVectorPotentialProjections(...)[source]#

Bases: abtem.magnetism.iam.QuasiDipoleProjections

Initialization

class abtem.magnetism.iam.VectorPotential(...)[source]#

Bases: abtem.potentials.iam._FieldBuilderFromAtoms, abtem.magnetism.iam.BaseMagneticField

Initialization

class abtem.magnetism.iam.VectorPotentialArray(...)[source]#

Bases: abtem.magnetism.iam.BaseVectorPotential, abtem.potentials.iam.FieldArray

adjust_coulomb_potential(...)[source]#
abstract classmethod from_array_and_metadata(...) → VectorPotentialArray[source]#
abtem.magnetism.iam.atomic_magnetic_field_3d(...) → ndarray[source]#
abtem.magnetism.iam.atomic_vector_potential_3d(...) → ndarray[source]#
abtem.magnetism.iam.bilinear_weighted_sum(...) → float[source]#
abtem.magnetism.iam.cartesian2polar_3d(...) → tuple[float, float, float][source]#
abtem.magnetism.iam.index_mask(...)[source]#
abtem.magnetism.iam.interpolate(...)[source]#
abtem.magnetism.iam.interpolate_quasi_dipole_field_projections(...)[source]#
abtem.magnetism.iam.interpolate_quasi_dipole_vector_field_projections(...)[source]#
abtem.magnetism.iam.magnetic_field_3d(...)[source]#
abtem.magnetism.iam.radial_cutoff(...)[source]#
abtem.magnetism.iam.radial_prefactor_a(...) → Callable[source]#
abtem.magnetism.iam.radial_prefactor_b1(...) → Callable[source]#
abtem.magnetism.iam.radial_prefactor_b2(...) → Callable[source]#
abtem.magnetism.iam.rotate_points_2d(...)[source]#
abtem.magnetism.iam.symmetric_arange(...) → ndarray[source]#
abtem.magnetism.iam.unit_vector_from_angles(...) → ndarray[source]#
abtem.magnetism.iam.vector_potential_3d(...)[source]#