get_equivalent_hkl#
- diffsims.crystallography.get_equivalent_hkl(hkl, operations, unique=False, return_multiplicity=False)[source]#
[Deprecated] Return symmetrically equivalent Miller indices.
- Parameters:
- hkl
orix.vector.Vector3d,np.ndarray,listortupleofint Miller indices.
- operations
orix.quaternion.symmetry.Symmetry Point group describing allowed symmetry operations.
- uniquebool,
optional Whether to return only unique Miller indices. Default is False.
- return_multiplicitybool,
optional Whether to return the multiplicity of the input indices. Default is False.
- hkl
- 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.
- new_hkl
Notes
Deprecated since version 0.6: Function get_equivalent_hkl() is deprecated and will be removed in version 0.7. Use diffsims.crystallography.ReciprocalLatticeVector.symmetrise() instead.