find_diffraction_calibration#
- pyxem.utils.calibration.find_diffraction_calibration(patterns, calibration_guess, library_phases, lib_gen, size, max_excitation_error=0.01, **kwargs)[source]#
[Deprecated] Finds the diffraction calibration for a pattern or set of patterns by maximizing correlation scores.
- Parameters:
patterns (hyperspy.signals.Signal2D) – Diffration patterns to be iteratively matched to find maximum correlation scores.
calibration_guess (float) – Inital value for the diffraction calibration in inverse Angstoms per pixel
library_phases (diffsims.libraries.StructureLibrary) – Dictionary of structures and associated orientations for which electron diffraction is to be simulated.
lib_gen (diffsims.generators.DiffractionLibraryGenerator) – Computes a library of electron diffraction patterns for specified atomic structures and orientations. Used to create the DiffractionLibrary.
size (integer) – How many different steps to test for the first two iterations. These steps have a size of 1% of the calibration guess.
max_excitation_error (float) – Maximum exacitation error. Default is 0.01.
kwargs – Keyword arguments passed to
index_dataset_with_template_rotation().
- Returns:
mean_cal (float) – Mean of calibrations found for each pattern.
full_corrlines (numpy.ndarray) – Gives the explicit correlation vs calibration values. Shape:(size*2 + 20, 2 , number of patterns)
found_cals (numpy.ndarray) – List of optimal calibration values for each pattern. Shape:(number of patterns)
Notes
Deprecated since version 0.18.0: Function find_diffraction_calibration() is deprecated and will be removed in version 1.0.0. Use pyxem.signals.Diffraction2D.calibrate() instead.