Function: h_equiv

Home

List of PyCrysFML08 Dictionaries

List of PyCrysFML08 Functions

USE

h_equiv returns True (False)if the two given reflections are symmetry equivalent (not symmetry equivalent) for the given space group.

r = h_equiv(h: ndarray,k: ndarray, spg : dict, kwargs : dict)

Variable	Type	Description
h	ndarray; dtype = int32; shape = :	Reflection index. Shape = 3 + n, where n is the number of propagation vectors.
k	ndarray; dtype = int32; shape = :	Reflection index. Shape = 3 + n, where n is the number of propagation vectors.
spg	dict	Space group. It must be a dictionary of type spg_type or superspacegroup_type. It can be generated with the function set_spacegroup.
kwargs	dict	Optional arguments. Keywords are: friedel.
	friedel	bool	If True, Friedel's law is applied.
r	tuple	The tuple returned by the function. r[0] : int, error code. If non-zero, an error has occurred. r[1] : str, error message. r[2]: bool; True if both reflections are symmetry equivalent, False otherwise.