Skip to main content

Ctrl+K

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
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
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
structure_factor
utils

API reference
generators
simulation_generator

simulation_generator#

Kinematic Diffraction Simulation Generator.

Classes

SimulationGenerator([accelerating_voltage, ...])

A class for generating kinematic diffraction simulations.

previous

get_uv_sphere_mesh_vertices

next

SimulationGenerator

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

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.18.0.