index_vectors#
- VectorIndexationGenerator.index_vectors(mag_tol, angle_tol, index_error_tol, n_peaks_to_index, n_best, *args, **kwargs)[source]#
Assigns hkl indices to diffraction vectors.
- Parameters:
mag_tol (float) – The maximum absolute error in diffraction vector magnitude, in units of reciprocal Angstroms, allowed for indexation.
angle_tol (float) – The maximum absolute error in inter-vector angle, in units of degrees, allowed for indexation.
index_error_tol (float) – Max allowed error in peak indexation for classifying it as indexed, calculated as \(|hkl_calculated - round(hkl_calculated)|\).
n_peaks_to_index (int) – The maximum number of peak to index.
n_best (int) – The maximum number of good solutions to be retained.
*args (arguments) – Arguments passed to the map() function.
**kwargs (arguments) – Keyword arguments passed to the map() function.
- Returns:
indexation_results – Navigation axes of the diffraction vectors signal containing vector indexation results for each probe position.
- Return type: