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

Correlation2D#

class pyxem.signals.Correlation2D(*args, **kwargs)[source]#

Bases: Signal2D, CommonDiffraction

Signal class for Correlation data after applying some correlation along some axis.

Attributes

Methods

Correlation2D.get_angular_power([inplace])

Returns the power spectrum of the angular auto-correlation function in the form of a Signal2D class.

Correlation2D.get_summed_angular_power([inplace])

Returns the power spectrum of the summed angular auto-correlation function over all real space positions.

Correlation2D.get_symmetry_coefficient([...])

This function is for finding and extracting information about clusters based on the angular symmetries. This a pretty catch all method which has a couple of different operating principles. If k_range=None the function uses a 3 dimensional version of blob finding and attempts to find blobs in the 3 dimensional space, x,y,k for each symmetry. :Parameters: * symmetries (list) -- The symmetries to calculate * method (str) -- One of max or average * include_duplicates (bool) -- Include duplicates like 2 and 4 * return:.