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

index_peaks#

ProfileIndexationGenerator.index_peaks(tolerance=0.1, *args, **kwargs)[source]#

Assigns hkl indices to peaks in the diffraction profile.

Parameters:
  • tolerance (float) – The n orientations with the highest correlation values are returned.

  • keys (list) – If more than one phase present in library it is recommended that these are submitted. This allows a mapping from the number to the phase. For example, keys = [‘si’,’ga’] will have an output with 0 for ‘si’ and 1 for ‘ga’.

  • *args (arguments) – Arguments passed to the map() function.

  • **kwargs (arguments) – Keyword arguments passed to the map() function.

Returns:

matching_results

Return type:

ProfileIndexation