get_equivalent_hkl#
- diffsims.crystallography.get_equivalent_hkl(hkl, operations, unique=False, return_multiplicity=False)[source]#
Return symmetrically equivalent Miller indices.
- Parameters:
hkl (orix.vector.Vector3d, np.ndarray, list or tuple of int) – Miller indices.
operations (orix.quaternion.symmetry.Symmetry) – Point group describing allowed symmetry operations.
unique (bool, optional) – Whether to return only unique Miller indices. Default is False.
return_multiplicity (bool, optional) – Whether to return the multiplicity of the input indices. Default is False.
- Returns:
new_hkl (orix.vector.Vector3d) – The symmetrically equivalent Miller indices.
multiplicity (np.ndarray) – Number of symmetrically equivalent indices. Only returned if return_multiplicity is True.