add_shot_and_point_spread#

diffsims.pattern.detector_functions.add_shot_and_point_spread(pattern, sigma, shot_noise=True, seed=None)[source]#

Adds shot noise (optional) and gaussian point spread (via a convolution) to a pattern

Parameters:
  • pattern (numpy.ndarray) – The diffraction pattern at the detector

  • sigma (float) – The standard deviation of the gaussian blur, in pixels

  • shot_noise (bool) – Whether to include shot noise in the original signal, default True

  • seed (int or None) – seed value for the random number generator (effects the shot noise only)

Returns:

detector_pattern – A single sample of the pattern after accounting for detector properties

Return type:

numpy.ndarray

See also

add_shot_noise

adds only shot noise

add_gaussian_point_spread

adds only point spread