get_symmetry_coefficient#
- Correlation1D.get_symmetry_coefficient(angular_range=0.1, symmetries=[2, 3, 4, 5, 6, 7, 8, 9, 10], method='average', include_duplicates=False, normalize=True)[source]#
Return symmetry coefficient from pearson correlation function at all real space positions (n from 2 to 10).
- Parameters:
angular_range (float) – The angular range (in rad) to integrate over when calculating the symmetry coefficient.
symmetries (list) – The list of symmetries to calculate.
method (“average”, “first”, “max”) – The method for calculating the Symmetry STEM
include_duplicates (bool) – If angles which are duplicated should be included.
normalize (bool) – This normalized by dividing by the number of angles for each symmetry.
- Returns:
sn – Symmetry coefficient
- Return type:
Signal1D