symmetrise#

Miller.symmetrise(unique: bool = False, return_multiplicity: bool = False, return_index: bool = False) → Miller | tuple[Miller, ndarray] | tuple[Miller, ndarray, ndarray][source]#

Return vectors symmetrically equivalent to the vectors.

Parameters:

unique: Whether to return only unique vectors. Default is False.
return_multiplicity: Whether to return the multiplicity of each vector. Default is False.
return_index: Whether to return the index into the vectors for the returned symmetrically equivalent vectors. Default is False.

Returns:

m: Flattened symmetrically equivalent vectors.
multiplicity: Multiplicity of each vector. Returned if return_multiplicity=True.
idx: Index into the vectors for the returned symmetrically equivalent vectors. Returned if return_index=True.

Examples using `Miller.symmetrise`#

Restrict to fundamental sector

Restrict to fundamental sector