radtools.SpinHamiltonian.get_atom_coordinates#

method

SpinHamiltonian.get_atom_coordinates(atom: Atom | str, R=(0, 0, 0), index=None, relative=True)#

Getter for the atom coordinates.

Parameters:
atomAtom or str

:py:class`.Atom` object or atom`s name. If name, then it has to be unique among atoms of the crystal.

indexint, optional

Index of the atom.

R(3,) array-like, default (0, 0, 0)

Radius vector of the unit cell for atom2 (i,j,k).

relativebool, default True

Whether to return relative coordinates.

Returns:
coordinates1 x 3 array

Coordinates of atom in the cell R in absolute coordinates.