# {py:mod}`abtem.bloch.utils` ```{py:module} abtem.bloch.utils ``` ```{autodoc2-docstring} abtem.bloch.utils :parser: rst :allowtitles: ``` ## Module Contents ### Functions ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`all_positions_have_relative_periodic_pair ` - ```{autodoc2-docstring} abtem.bloch.utils.all_positions_have_relative_periodic_pair :parser: rst :summary: ``` * - {py:obj}`are_vectors_orthogonal ` - ```{autodoc2-docstring} abtem.bloch.utils.are_vectors_orthogonal :parser: rst :summary: ``` * - {py:obj}`auto_detect_centering ` - ```{autodoc2-docstring} abtem.bloch.utils.auto_detect_centering :parser: rst :summary: ``` * - {py:obj}`calculate_g_vec ` - ```{autodoc2-docstring} abtem.bloch.utils.calculate_g_vec :parser: rst :summary: ``` * - {py:obj}`calculate_g_vec_length ` - ```{autodoc2-docstring} abtem.bloch.utils.calculate_g_vec_length :parser: rst :summary: ``` * - {py:obj}`cell_bounds ` - ```{autodoc2-docstring} abtem.bloch.utils.cell_bounds :parser: rst :summary: ``` * - {py:obj}`check_orthogonality ` - ```{autodoc2-docstring} abtem.bloch.utils.check_orthogonality :parser: rst :summary: ``` * - {py:obj}`excitation_errors ` - ```{autodoc2-docstring} abtem.bloch.utils.excitation_errors :parser: rst :summary: ``` * - {py:obj}`fast_filter_excitation_errors ` - ```{autodoc2-docstring} abtem.bloch.utils.fast_filter_excitation_errors :parser: rst :summary: ``` * - {py:obj}`filter_reciprocal_space_vectors ` - ```{autodoc2-docstring} abtem.bloch.utils.filter_reciprocal_space_vectors :parser: rst :summary: ``` * - {py:obj}`generate_linear_combinations ` - ```{autodoc2-docstring} abtem.bloch.utils.generate_linear_combinations :parser: rst :summary: ``` * - {py:obj}`get_reflection_condition ` - ```{autodoc2-docstring} abtem.bloch.utils.get_reflection_condition :parser: rst :summary: ``` * - {py:obj}`get_shortest_g_vec_length ` - ```{autodoc2-docstring} abtem.bloch.utils.get_shortest_g_vec_length :parser: rst :summary: ``` * - {py:obj}`hkl_strings_to_array ` - ```{autodoc2-docstring} abtem.bloch.utils.hkl_strings_to_array :parser: rst :summary: ``` * - {py:obj}`make_hkl_grid ` - ```{autodoc2-docstring} abtem.bloch.utils.make_hkl_grid :parser: rst :summary: ``` * - {py:obj}`ravel_hkl ` - ```{autodoc2-docstring} abtem.bloch.utils.ravel_hkl :parser: rst :summary: ``` * - {py:obj}`reciprocal_cell ` - ```{autodoc2-docstring} abtem.bloch.utils.reciprocal_cell :parser: rst :summary: ``` * - {py:obj}`reciprocal_space_gpts ` - ```{autodoc2-docstring} abtem.bloch.utils.reciprocal_space_gpts :parser: rst :summary: ``` * - {py:obj}`relative_positions_for_centering ` - ```{autodoc2-docstring} abtem.bloch.utils.relative_positions_for_centering :parser: rst :summary: ``` * - {py:obj}`retrieve_structure_factor_values ` - ```{autodoc2-docstring} abtem.bloch.utils.retrieve_structure_factor_values :parser: rst :summary: ``` * - {py:obj}`wrapped_is_close ` - ```{autodoc2-docstring} abtem.bloch.utils.wrapped_is_close :parser: rst :summary: ``` ```` ### API ````{py:function} all_positions_have_relative_periodic_pair(...) -> bool :canonical: abtem.bloch.utils.all_positions_have_relative_periodic_pair ```{autodoc2-docstring} abtem.bloch.utils.all_positions_have_relative_periodic_pair :parser: rst ``` ```` ````{py:function} are_vectors_orthogonal(...) -> bool :canonical: abtem.bloch.utils.are_vectors_orthogonal ```{autodoc2-docstring} abtem.bloch.utils.are_vectors_orthogonal :parser: rst ``` ```` ````{py:function} auto_detect_centering(...) -> str :canonical: abtem.bloch.utils.auto_detect_centering ```{autodoc2-docstring} abtem.bloch.utils.auto_detect_centering :parser: rst ``` ```` ````{py:function} calculate_g_vec(...) -> numpy.ndarray :canonical: abtem.bloch.utils.calculate_g_vec ```{autodoc2-docstring} abtem.bloch.utils.calculate_g_vec :parser: rst ``` ```` ````{py:function} calculate_g_vec_length(...) -> numpy.ndarray :canonical: abtem.bloch.utils.calculate_g_vec_length ```{autodoc2-docstring} abtem.bloch.utils.calculate_g_vec_length :parser: rst ``` ```` ````{py:function} cell_bounds(...) -> numpy.ndarray :canonical: abtem.bloch.utils.cell_bounds ```{autodoc2-docstring} abtem.bloch.utils.cell_bounds :parser: rst ``` ```` ````{py:function} check_orthogonality(...) -> bool :canonical: abtem.bloch.utils.check_orthogonality ```{autodoc2-docstring} abtem.bloch.utils.check_orthogonality :parser: rst ``` ```` ````{py:function} excitation_errors(...) -> numpy.ndarray :canonical: abtem.bloch.utils.excitation_errors ```{autodoc2-docstring} abtem.bloch.utils.excitation_errors :parser: rst ``` ```` ````{py:function} fast_filter_excitation_errors(...) -> None :canonical: abtem.bloch.utils.fast_filter_excitation_errors ```{autodoc2-docstring} abtem.bloch.utils.fast_filter_excitation_errors :parser: rst ``` ```` ````{py:function} filter_reciprocal_space_vectors(...) -> numpy.ndarray :canonical: abtem.bloch.utils.filter_reciprocal_space_vectors ```{autodoc2-docstring} abtem.bloch.utils.filter_reciprocal_space_vectors :parser: rst ``` ```` ````{py:function} generate_linear_combinations(...) -> numpy.ndarray :canonical: abtem.bloch.utils.generate_linear_combinations ```{autodoc2-docstring} abtem.bloch.utils.generate_linear_combinations :parser: rst ``` ```` ````{py:function} get_reflection_condition(...) -> numpy.ndarray :canonical: abtem.bloch.utils.get_reflection_condition ```{autodoc2-docstring} abtem.bloch.utils.get_reflection_condition :parser: rst ``` ```` ````{py:function} get_shortest_g_vec_length(...) -> float :canonical: abtem.bloch.utils.get_shortest_g_vec_length ```{autodoc2-docstring} abtem.bloch.utils.get_shortest_g_vec_length :parser: rst ``` ```` ````{py:function} hkl_strings_to_array(...) -> numpy.ndarray :canonical: abtem.bloch.utils.hkl_strings_to_array ```{autodoc2-docstring} abtem.bloch.utils.hkl_strings_to_array :parser: rst ``` ```` ````{py:function} make_hkl_grid(...) -> numpy.ndarray :canonical: abtem.bloch.utils.make_hkl_grid ```{autodoc2-docstring} abtem.bloch.utils.make_hkl_grid :parser: rst ``` ```` ````{py:function} ravel_hkl(...) -> numpy.ndarray :canonical: abtem.bloch.utils.ravel_hkl ```{autodoc2-docstring} abtem.bloch.utils.ravel_hkl :parser: rst ``` ```` ````{py:function} reciprocal_cell(...) -> numpy.ndarray :canonical: abtem.bloch.utils.reciprocal_cell ```{autodoc2-docstring} abtem.bloch.utils.reciprocal_cell :parser: rst ``` ```` ````{py:function} reciprocal_space_gpts(...) -> tuple[int, int, int] :canonical: abtem.bloch.utils.reciprocal_space_gpts ```{autodoc2-docstring} abtem.bloch.utils.reciprocal_space_gpts :parser: rst ``` ```` ````{py:function} relative_positions_for_centering() -> dict[str, numpy.ndarray] :canonical: abtem.bloch.utils.relative_positions_for_centering ```{autodoc2-docstring} abtem.bloch.utils.relative_positions_for_centering :parser: rst ``` ```` ````{py:function} retrieve_structure_factor_values(...) -> numpy.ndarray :canonical: abtem.bloch.utils.retrieve_structure_factor_values ```{autodoc2-docstring} abtem.bloch.utils.retrieve_structure_factor_values :parser: rst ``` ```` ````{py:function} wrapped_is_close(...) :canonical: abtem.bloch.utils.wrapped_is_close ```{autodoc2-docstring} abtem.bloch.utils.wrapped_is_close :parser: rst ``` ````