Check out the Hyperspy Workshop May 13-17, 2024 Online

get_diffraction_variance#

VarianceGenerator.get_diffraction_variance(dqe, set_data_type=None)[source]#

[Deprecated] Calculates the variance in scattered intensity as a function of scattering vector.

Parameters:
  • dqe (float) – Detective quantum efficiency of the detector for Poisson noise correction.

  • data_type (numpy data type.) – For numpy data types, see https://docs.scipy.org/doc/numpy-1.13.0/user/basics.types.html. This is incorporated as squaring the numbers in meansq_dp results in considerably larger than the ones in the original array. This can result in an overflow error that is difficult to distinguish. Hence the data can be converted to a different data type to accommodate.

Returns:

vardps – A DiffractionVariance2D object containing the mean DP, mean squared DP, and variance DP.

Return type:

DiffractionVariance2D

Notes

Deprecated since version 0.15: Function get_diffraction_variance() is deprecated and will be removed in version 1.0.0. Use pyxem.signals.diffraction2d.get_variance() instead.