# Hfc display.m

From Spinach Documentation Wiki

Ellipsoid plots of hyperfine coupling tensors and their eigensystems.

## Syntax

hfc_display(props,atoms,scaling_factor,conmatrix)

## Description

This function takes the information loaded from quantum chemistry packages by the various parser functions (gparse, oparse, etc.) and uses it to create ellipsoid plots of hyperfine coupling tensors. Every ellipsoid is drawn in the following way:

- A unit sphere in a Cartesian space is scaled by abs(Axx) in the x direction, abs(Ayy) in the y direction and abs(Azz) in the z direction, where Axx, Ayy, Azz are the eigenvalues of the hyperfine coupling tensor in units of mT.
- A set of axes is drawn inside the sphere with red axis for positive eigenvalues and blue for negative ones.
- The sphere is translated to the point of corresponding atom and rotated into the molecular frame.

## Arguments

props - output of the quantum chemistry package output parser function

atoms - a cell array of element symbols, indicating the atoms for which the hyperfine coupling tensors should be visualized, e.g. {'C','H'}

scaling_factor - scaling factor, connecting the mT scale to the length units in Angstrom that are used in the molecule plot, usually of the order of 0.01

conmatrix - optional binary connectivity matrix, with 1 if a pair of atoms should be connected by a bond in the resulting plot and zero otherwise. If you are happy with the default bond drawing threshold of 1.6 Angstrom, specify an empty matrix here.

## Returns

The function creates a figure.

## Examples

The following figure is produced by /examples/visualisation/hfc_pyrene.m

## Notes

- Software OpenGL is forced internally because hardware OpenGL works badly with transparency in Matlab.
- Antisymmetric components of the hyperfine coupling tensors are ignored.
- Only Gaussian quantum chemistry package is supported at the moment - send an email to Ilya Kuprov if you are using somethng else.

*Revision 3284, authors: Ilya Kuprov*