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
- ReciprocalLatticePoint
  - allowed
  - dspacing
  - gspacing
  - h
  - hkl
  - k
  - l
  - multiplicity
  - scattering_parameter
  - shape
  - size
  - structure_factor
  - theta
  - calculate_structure_factor
  - calculate_theta
  - from_highest_hkl
  - from_min_dspacing
  - symmetrise
  - unique
- ReciprocalLatticeVector
  - allowed
  - coordinate_format
  - coordinates
  - dspacing
  - gspacing
  - h
  - has_hexagonal_lattice
  - hkil
  - hkl
  - i
  - k
  - l
  - multiplicity
  - scattering_parameter
  - structure_factor
  - theta
  - unit
  - angle_with
  - calculate_structure_factor
  - calculate_theta
  - cross
  - deepcopy
  - dot
  - dot_outer
  - empty
  - flatten
  - from_highest_hkl
  - from_miller
  - from_min_dspacing
  - from_polar
  - get_hkl_sets
  - get_nearest
  - get_random_sample
  - in_fundamental_sector
  - mean
  - print_table
  - reshape
  - rotate
  - sanitise_phase
  - squeeze
  - stack
  - symmetrise
  - to_miller
  - transpose
  - unique
  - xvector
  - yvector
  - zero
  - zvector
generators
libraries
pattern
- detector_functions
sims
- diffraction_simulation
  - DiffractionSimulation
  - ProfileSimulation
    - get_plot
structure_factor
utils

API reference
mask_utils
create_mask

create_mask#

diffsims.utils.mask_utils.create_mask(shape, fill=True)[source]#: Initiate an empty mask

previous

add_polygon_to_mask

next

invert_mask

On this page

create_mask()

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

Created using Sphinx 7.2.6.

Built with the PyData Sphinx Theme 0.15.2.