get_filtered_combinations

pyxem.utils.vectors.get_filtered_combinations(pks, num, radial_index=0, angle_index=1, intensity_index=None, intensity_threshold=None, min_angle=None, min_k=None)

Creates combinations of num peaks but forces at least one of the combinations to have an intensity higher than the intensity_threshold. This filter is useful for finding high intensity features but not losing lower intensity paired features which contribute to symmetry etc.

Parameters:

• pks (numpy.ndarray) – The diffraction vectors to be analyzed

• num (int) – The number of peaks to be combined

• radial_index (int, optional) – The index of the radial component of the diffraction vectors, by default 0

• angle_index (int, optional) – The index of the angular component of the diffraction vectors, by default 1

• intensity_index (int, optional) – The index of the intensity component of the diffraction vectors, by default None

• intensity_threshold (float, optional) – The minimum intensity of the diffraction vectors to be considered, by default None

• min_angle (float, optional) – The minimum angle between two diffraction vectors. This ignores small angles which are likely to be from the same feature or unphysical.

• min_k (float, optional) – The minimum difference between the radial component of the diffraction vectors to be considered from the same feature, by default 0.05