# {py:mod}`abtem.integrals` ```{py:module} abtem.integrals ``` ```{autodoc2-docstring} abtem.integrals :parser: rst :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`FieldIntegrator ` - ```{autodoc2-docstring} abtem.integrals.FieldIntegrator :parser: rst :summary: ``` * - {py:obj}`GaussianProjectionIntegrals ` - ```{autodoc2-docstring} abtem.integrals.GaussianProjectionIntegrals :parser: rst :summary: ``` * - {py:obj}`ProjectionIntegralTable ` - ```{autodoc2-docstring} abtem.integrals.ProjectionIntegralTable :parser: rst :summary: ``` * - {py:obj}`QuadratureProjectionIntegrals ` - ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals :parser: rst :summary: ``` * - {py:obj}`ScatteringFactorProjectionIntegrals ` - ```{autodoc2-docstring} abtem.integrals.ScatteringFactorProjectionIntegrals :parser: rst :summary: ``` ```` ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`correction_projected_scattering_factors ` - ```{autodoc2-docstring} abtem.integrals.correction_projected_scattering_factors :parser: rst :summary: ``` * - {py:obj}`cutoff_taper ` - ```{autodoc2-docstring} abtem.integrals.cutoff_taper :parser: rst :summary: ``` * - {py:obj}`gaussian_projected_scattering_factors ` - ```{autodoc2-docstring} abtem.integrals.gaussian_projected_scattering_factors :parser: rst :summary: ``` * - {py:obj}`gaussian_projection_weights ` - ```{autodoc2-docstring} abtem.integrals.gaussian_projection_weights :parser: rst :summary: ``` * - {py:obj}`interpolate_radial_functions ` - ```{autodoc2-docstring} abtem.integrals.interpolate_radial_functions :parser: rst :summary: ``` * - {py:obj}`optimize_cutoff ` - ```{autodoc2-docstring} abtem.integrals.optimize_cutoff :parser: rst :summary: ``` * - {py:obj}`sinc ` - ```{autodoc2-docstring} abtem.integrals.sinc :parser: rst :summary: ``` * - {py:obj}`superpose_deltas ` - ```{autodoc2-docstring} abtem.integrals.superpose_deltas :parser: rst :summary: ``` ```` ### API `````{py:class} FieldIntegrator(...) :canonical: abtem.integrals.FieldIntegrator Bases: {py:obj}`abtem.core.utils.EqualityMixin`, {py:obj}`abtem.core.utils.CopyMixin` ```{autodoc2-docstring} abtem.integrals.FieldIntegrator :parser: rst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} abtem.integrals.FieldIntegrator.__init__ :parser: rst ``` ````{py:method} cutoff(...) -> float :canonical: abtem.integrals.FieldIntegrator.cutoff :abstractmethod: ```{autodoc2-docstring} abtem.integrals.FieldIntegrator.cutoff :parser: rst ``` ```` ````{py:property} finite :canonical: abtem.integrals.FieldIntegrator.finite :type: bool ```{autodoc2-docstring} abtem.integrals.FieldIntegrator.finite :parser: rst ``` ```` ````{py:method} integrate_on_grid(...) -> numpy.ndarray :canonical: abtem.integrals.FieldIntegrator.integrate_on_grid :abstractmethod: ```{autodoc2-docstring} abtem.integrals.FieldIntegrator.integrate_on_grid :parser: rst ``` ```` ````{py:property} periodic :canonical: abtem.integrals.FieldIntegrator.periodic :type: bool ```{autodoc2-docstring} abtem.integrals.FieldIntegrator.periodic :parser: rst ``` ```` ````` `````{py:class} GaussianProjectionIntegrals(...) :canonical: abtem.integrals.GaussianProjectionIntegrals Bases: {py:obj}`abtem.integrals.FieldIntegrator` ```{autodoc2-docstring} abtem.integrals.GaussianProjectionIntegrals :parser: rst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} abtem.integrals.GaussianProjectionIntegrals.__init__ :parser: rst ``` ````{py:property} correction_parametrization :canonical: abtem.integrals.GaussianProjectionIntegrals.correction_parametrization ```{autodoc2-docstring} abtem.integrals.GaussianProjectionIntegrals.correction_parametrization :parser: rst ``` ```` ````{py:method} cutoff(...) -> float :canonical: abtem.integrals.GaussianProjectionIntegrals.cutoff ```` ````{py:property} cutoff_tolerance :canonical: abtem.integrals.GaussianProjectionIntegrals.cutoff_tolerance ```{autodoc2-docstring} abtem.integrals.GaussianProjectionIntegrals.cutoff_tolerance :parser: rst ``` ```` ````{py:property} gaussian_parametrization :canonical: abtem.integrals.GaussianProjectionIntegrals.gaussian_parametrization ```{autodoc2-docstring} abtem.integrals.GaussianProjectionIntegrals.gaussian_parametrization :parser: rst ``` ```` ````{py:method} get_corrections(...) :canonical: abtem.integrals.GaussianProjectionIntegrals.get_corrections ```{autodoc2-docstring} abtem.integrals.GaussianProjectionIntegrals.get_corrections :parser: rst ``` ```` ````{py:method} get_gaussians(...) :canonical: abtem.integrals.GaussianProjectionIntegrals.get_gaussians ```{autodoc2-docstring} abtem.integrals.GaussianProjectionIntegrals.get_gaussians :parser: rst ``` ```` ````{py:method} integrate_on_grid(...) -> numpy.ndarray :canonical: abtem.integrals.GaussianProjectionIntegrals.integrate_on_grid ```` ````` `````{py:class} ProjectionIntegralTable(...) :canonical: abtem.integrals.ProjectionIntegralTable ```{autodoc2-docstring} abtem.integrals.ProjectionIntegralTable :parser: rst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} abtem.integrals.ProjectionIntegralTable.__init__ :parser: rst ``` ````{py:method} integrate(...) -> numpy.ndarray :canonical: abtem.integrals.ProjectionIntegralTable.integrate ```{autodoc2-docstring} abtem.integrals.ProjectionIntegralTable.integrate :parser: rst ``` ```` ````{py:property} limits :canonical: abtem.integrals.ProjectionIntegralTable.limits :type: numpy.ndarray ```{autodoc2-docstring} abtem.integrals.ProjectionIntegralTable.limits :parser: rst ``` ```` ````{py:property} radial_gpts :canonical: abtem.integrals.ProjectionIntegralTable.radial_gpts :type: numpy.ndarray ```{autodoc2-docstring} abtem.integrals.ProjectionIntegralTable.radial_gpts :parser: rst ``` ```` ````{py:property} values :canonical: abtem.integrals.ProjectionIntegralTable.values :type: numpy.ndarray ```{autodoc2-docstring} abtem.integrals.ProjectionIntegralTable.values :parser: rst ``` ```` ````` `````{py:class} QuadratureProjectionIntegrals(...) :canonical: abtem.integrals.QuadratureProjectionIntegrals Bases: {py:obj}`abtem.integrals.FieldIntegrator` ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals :parser: rst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals.__init__ :parser: rst ``` ````{py:method} cutoff(...) -> float :canonical: abtem.integrals.QuadratureProjectionIntegrals.cutoff ```` ````{py:property} cutoff_tolerance :canonical: abtem.integrals.QuadratureProjectionIntegrals.cutoff_tolerance :type: float ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals.cutoff_tolerance :parser: rst ``` ```` ````{py:method} get_integral_table(...) :canonical: abtem.integrals.QuadratureProjectionIntegrals.get_integral_table ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals.get_integral_table :parser: rst ``` ```` ````{py:method} integrate_on_grid(...) -> numpy.ndarray :canonical: abtem.integrals.QuadratureProjectionIntegrals.integrate_on_grid ```` ````{py:property} integration_step :canonical: abtem.integrals.QuadratureProjectionIntegrals.integration_step :type: float ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals.integration_step :parser: rst ``` ```` ````{py:property} parametrization :canonical: abtem.integrals.QuadratureProjectionIntegrals.parametrization ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals.parametrization :parser: rst ``` ```` ````{py:property} quad_order :canonical: abtem.integrals.QuadratureProjectionIntegrals.quad_order ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals.quad_order :parser: rst ``` ```` ````{py:property} tables :canonical: abtem.integrals.QuadratureProjectionIntegrals.tables ```{autodoc2-docstring} abtem.integrals.QuadratureProjectionIntegrals.tables :parser: rst ``` ```` ````` `````{py:class} ScatteringFactorProjectionIntegrals(...) :canonical: abtem.integrals.ScatteringFactorProjectionIntegrals Bases: {py:obj}`abtem.integrals.FieldIntegrator` ```{autodoc2-docstring} abtem.integrals.ScatteringFactorProjectionIntegrals :parser: rst ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} abtem.integrals.ScatteringFactorProjectionIntegrals.__init__ :parser: rst ``` ````{py:method} cutoff(...) -> float :canonical: abtem.integrals.ScatteringFactorProjectionIntegrals.cutoff ```` ````{py:method} get_scattering_factor(...) :canonical: abtem.integrals.ScatteringFactorProjectionIntegrals.get_scattering_factor ```{autodoc2-docstring} abtem.integrals.ScatteringFactorProjectionIntegrals.get_scattering_factor :parser: rst ``` ```` ````{py:method} integrate_on_grid(...) :canonical: abtem.integrals.ScatteringFactorProjectionIntegrals.integrate_on_grid ```` ````{py:property} parametrization :canonical: abtem.integrals.ScatteringFactorProjectionIntegrals.parametrization :type: abtem.parametrizations.Parametrization ```{autodoc2-docstring} abtem.integrals.ScatteringFactorProjectionIntegrals.parametrization :parser: rst ``` ```` ````{py:property} scattering_factors :canonical: abtem.integrals.ScatteringFactorProjectionIntegrals.scattering_factors :type: dict[str, numpy.ndarray] ```{autodoc2-docstring} abtem.integrals.ScatteringFactorProjectionIntegrals.scattering_factors :parser: rst ``` ```` ````` ````{py:function} correction_projected_scattering_factors(...) :canonical: abtem.integrals.correction_projected_scattering_factors ```{autodoc2-docstring} abtem.integrals.correction_projected_scattering_factors :parser: rst ``` ```` ````{py:function} cutoff_taper(...) :canonical: abtem.integrals.cutoff_taper ```{autodoc2-docstring} abtem.integrals.cutoff_taper :parser: rst ``` ```` ````{py:function} gaussian_projected_scattering_factors(...) :canonical: abtem.integrals.gaussian_projected_scattering_factors ```{autodoc2-docstring} abtem.integrals.gaussian_projected_scattering_factors :parser: rst ``` ```` ````{py:function} gaussian_projection_weights(...) :canonical: abtem.integrals.gaussian_projection_weights ```{autodoc2-docstring} abtem.integrals.gaussian_projection_weights :parser: rst ``` ```` ````{py:function} interpolate_radial_functions(...) :canonical: abtem.integrals.interpolate_radial_functions ```{autodoc2-docstring} abtem.integrals.interpolate_radial_functions :parser: rst ``` ```` ````{py:function} optimize_cutoff(...) -> float :canonical: abtem.integrals.optimize_cutoff ```{autodoc2-docstring} abtem.integrals.optimize_cutoff :parser: rst ``` ```` ````{py:function} sinc(...) -> numpy.ndarray :canonical: abtem.integrals.sinc ```{autodoc2-docstring} abtem.integrals.sinc :parser: rst ``` ```` ````{py:function} superpose_deltas(...) -> numpy.ndarray :canonical: abtem.integrals.superpose_deltas ```{autodoc2-docstring} abtem.integrals.superpose_deltas :parser: rst ``` ````