Skip to main content
Ctrl+K
diffsims diffsims

diffsims

  • User guide
  • API reference
  • Contributing
  • Changelog
  • GitHub
  • User guide
  • API reference
  • Contributing
  • Changelog
  • GitHub

Section Navigation

  • crystallography
    • get_equivalent_hkl
    • get_highest_hkl
    • get_hkl
    • ReciprocalLatticeVector
      • allowed
      • azimuth
      • coordinate_format
      • coordinates
      • data
      • dim
      • dspacing
      • gspacing
      • h
      • has_hexagonal_lattice
      • hkil
      • hkl
      • i
      • k
      • l
      • multiplicity
      • ndim
      • norm
      • perpendicular
      • polar
      • radial
      • scattering_parameter
      • shape
      • size
      • structure_factor
      • theta
      • unit
      • x
      • xyz
      • y
      • z
      • angle_with
      • calculate_structure_factor
      • calculate_theta
      • cross
      • deepcopy
      • dot
      • dot_outer
      • draw_circle
      • empty
      • flatten
      • from_highest_hkl
      • from_miller
      • from_min_dspacing
      • from_path_ends
      • from_polar
      • get_circle
      • get_hkl_sets
      • get_nearest
      • get_random_sample
      • in_fundamental_sector
      • inverse_pole_density_function
      • mean
      • pole_density_function
      • print_table
      • random
      • reshape
      • rotate
      • sanitise_phase
      • scatter
      • squeeze
      • stack
      • symmetrise
      • to_miller
      • to_polar
      • transpose
      • unique
      • xvector
      • yvector
      • zero
      • zvector
  • generators
    • diffraction_generator
      • AtomicDiffractionGenerator
        • calculate_ed_data
      • DiffractionGenerator
        • calculate_ed_data
        • calculate_profile_data
    • library_generator
      • DiffractionLibraryGenerator
        • get_diffraction_library
      • VectorLibraryGenerator
        • get_vector_library
    • rotation_list_generators
      • get_beam_directions_grid
      • get_fundamental_zone_grid
      • get_grid_around_beam_direction
      • get_list_from_orix
      • get_local_grid
    • sphere_mesh_generators
      • beam_directions_grid_to_euler
      • get_cube_mesh_vertices
      • get_icosahedral_mesh_vertices
      • get_random_sphere_vertices
      • get_uv_sphere_mesh_vertices
    • simulation_generator
      • SimulationGenerator
        • wavelength
        • calculate_diffraction1d
        • calculate_diffraction2d
        • get_intersecting_reflections
    • zap_map_generator
      • corners_to_centroid_and_edge_centers
      • generate_directional_simulations
      • generate_zap_map
      • get_rotation_from_z_to_direction
  • libraries
    • diffraction_library
      • load_DiffractionLibrary
      • DiffractionLibrary
        • clear
        • copy
        • fromkeys
        • get
        • get_library_entry
        • items
        • keys
        • pickle_library
        • pop
        • popitem
        • setdefault
        • update
        • values
    • structure_library
      • StructureLibrary
        • from_orientation_lists
        • get_library_size
    • vector_library
      • load_VectorLibrary
      • DiffractionVectorLibrary
        • clear
        • copy
        • fromkeys
        • get
        • items
        • keys
        • pickle_library
        • pop
        • popitem
        • setdefault
        • update
        • values
  • pattern
    • detector_functions
      • add_dead_pixels
      • add_detector_offset
      • add_gaussian_noise
      • add_gaussian_point_spread
      • add_linear_detector_gain
      • add_shot_noise
      • add_shot_and_point_spread
      • constrain_to_dynamic_range
      • get_pattern_from_pixel_coordinates_and_intensities
  • sims
    • diffraction_simulation
      • DiffractionSimulation
        • calibrated_coordinates
        • calibration
        • coordinates
        • direct_beam_mask
        • indices
        • intensities
        • size
        • deepcopy
        • extend
        • get_as_mask
        • get_diffraction_pattern
        • plot
        • rotate_shift_coordinates
      • ProfileSimulation
        • get_plot
  • simulations
    • Simulation1D
      • theta
      • plot
    • Simulation2D
      • current_phase
      • current_size
      • has_multiple_phases
      • has_multiple_rotations
      • num_phases
      • deepcopy
      • get_current_coordinates
      • get_current_rotation_matrix
      • get_diffraction_pattern
      • get_simulation
      • plot
      • plot_rotations
      • polar_flatten_simulations
      • rotate_shift_coordinates
  • structure_factor
    • get_doyleturner_atomic_scattering_factor
    • get_kinematical_atomic_scattering_factor
    • get_atomic_scattering_parameters
    • get_element_id_from_string
    • find_asymmetric_positions
    • get_doyleturner_structure_factor
    • get_kinematical_structure_factor
    • get_refraction_corrected_wavelength
  • utils
    • atomic_diffraction_generator_utils
      • get_diffraction_image
      • grid2sphere
      • precess_mat
    • atomic_scattering_params
    • discretise_utils
      • do_binning
      • get_atoms
      • get_discretisation
      • rebin
    • fourier_transform
      • convolve
      • fast_abs
      • fast_fft_len
      • fftn
      • fftshift_phase
      • from_recip
      • get_DFT
      • get_recip_points
      • ifftn
      • plan_fft
      • plan_ifft
      • to_recip
    • generic_utils
      • get_grid
      • to_mesh
      • GLOBAL_BOOL
        • set
    • kinematic_simulation_utils
      • get_diffraction_image
      • grid2sphere
      • normalise
      • precess_mat
    • lobato_scattering_params
    • probe_utils
      • BesselProbe
      • ProbeFunction
    • scattering_params
    • shape_factor_models
      • atanc
      • binary
      • linear
      • lorentzian
      • lorentzian_precession
      • sin2c
      • sinc
    • sim_utils
      • acceleration_voltage_to_relativistic_mass
      • acceleration_voltage_to_velocity
      • acceleration_voltage_to_wavelength
      • beta_to_bst
      • bst_to_beta
      • diffraction_scattering_angle
      • et_to_beta
      • get_atomic_scattering_factors
      • get_electron_wavelength
      • get_holz_angle
      • get_intensities_params
      • get_interaction_constant
      • get_kinematical_intensities
      • get_points_in_sphere
      • get_scattering_params_dict
      • get_unique_families
      • get_vectorized_list_for_atomic_scattering_factors
      • is_lattice_hexagonal
      • scattering_angle_to_lattice_parameter
      • simulate_kinematic_scattering
      • tesla_to_am
      • uvtw_to_uvw
    • vector_utils
      • get_angle_cartesian
      • get_angle_cartesian_vec
      • vectorised_spherical_polars_to_cartesians
    • mask_utils
      • add_annulus_to_mask
      • add_band_to_mask
      • add_circle_to_mask
      • add_circles_to_mask
      • add_polygon_to_mask
      • create_mask
      • invert_mask
  • API reference
  • libraries

libraries#

Diffraction, structure and vector libraries.

Modules

diffraction_library

structure_library

vector_library

previous

get_rotation_from_z_to_direction

next

diffraction_library
Edit on GitHub
Show Source

© Copyright 2018-2026, Duncan Johnstone, Phillip Crout.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.18.0.