print

Function: get_h_info

Reference

Home

List of PyCrysFML08 Dictionaries

List of PyCrysFML08 Functions

USE

get_h_info returns information about a particular reflection. Information consists of four numbers. The first three specifies if the reflection is allowed (0) or absent (1) by lattice, nuclear and magnetic constraints. The fourth number refers to the character of the reflection: pure nuclear (0), pure magnetic (1) and nuclear + magnetic (2).

function call

r = get_h_info(h: ndarray,spg : dict, mag : bool)

VariableTypeDescription
hndarray; dtype = int32; shape = :Reflection index. Shape = 3 + n, where n is the number of propagation vectors.
spgdictSpace group. It must be a dictionary of type spg_type or superspacegroup_type. It can be generated with the function set_spacegroup.
magboolTrue if magnetic scattering must be considered.
rtuple

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]: ndarray; dtype = int32; shape = 4, information about h.

examples