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

subpixel_refine#

DiffractionVectors.subpixel_refine(signal, method='center-of-mass', disk_r=None, upsample_factor=2, square_size=10, columns=None, **kwargs)[source]#

Refine the positions of the diffraction vectors using subpixel interpolation.

Parameters:
  • signal (hyperspy.api.signals.BaseSignal) – The signal which will be used to refine the diffraction vectors.

  • method (str) – The method used to refine the diffraction vectors. Currently supported methods are ‘cross-correlation’ and and “center-of-mass”.

  • disk_r (int or None) – The radius of the disk used for the cross-correlation method in pixels.

  • upsample_factor (int) – The upsample factor used for the cross-correlation method.

  • square_size (int) – The size of the square used for both the center-of-mass and cross-correlation methods.

  • columns (list) – The columns for the pixels of interest. If None, the first two columns are used.

  • kwargs (dict) – Additional keyword arguments to be passed to the map method.

Returns:

refined_vectors – The refined vectors.

Return type:

DiffractionVectors