Difference between revisions of "Hfc display.m"

From Spinach Documentation Wiki
Jump to: navigation, search
(Examples)
(Sync syntax/arguments/outputs with current Spinach source)
Line 1: Line 1:
 
{{DISPLAYTITLE:hfc_display.m}} __NOTOC__
 
{{DISPLAYTITLE:hfc_display.m}} __NOTOC__
 +
 
Draws hyperfine tensors and their eigensystems. Two styles are implemented:
 
Draws hyperfine tensors and their eigensystems. Two styles are implemented:
  
Line 18: Line 19:
 
==Syntax==
 
==Syntax==
  
    hfc_display(props,atoms,scaling,conmatrix,options)
+
hfc_display(props,atoms,scaling,conmatrix,options)
  
 
==Arguments==
 
==Arguments==
  
              props - output of [[gparse.m]] function
+
props - output of gparse.m function
+
 
               atoms - a cell array of element symbols,
+
               atoms - a cell array of element symbols
                       indicating the atoms for which
+
                      or a vector of integers, indica-
                       the hyperfine tensors should be
+
                       ting the atoms for which hyper-
                       visualised, e.g. {'C','H'}
+
                       fine tensors should be visuali-
+
                       sed, e.g. {'C','H'} or [1 2 5]
 +
 
 
             scaling - a factor to scale the tensors
 
             scaling - a factor to scale the tensors
 
                       by for visualisation
 
                       by for visualisation
+
 
 
           conmatrix - binary connectivity matrix, 1
 
           conmatrix - binary connectivity matrix, 1
 
                       if a pair of atoms should be
 
                       if a pair of atoms should be
 
                       connected by a bond. If an em-
 
                       connected by a bond. If an em-
                       pty vector is supplied, 1.6  
+
                       pty vector is supplied, 1.6
 
                       Angstrom cutoff distance is used
 
                       Angstrom cutoff distance is used
+
 
 
       options.style - 'ellipsoids' or 'harmonics'
 
       options.style - 'ellipsoids' or 'harmonics'
+
 
 
     options.kill_iso - set to true() to eliminate the
 
     options.kill_iso - set to true() to eliminate the
 
                       isotropic parts of tensors be-
 
                       isotropic parts of tensors be-
 
                       fore plotting
 
                       fore plotting
 +
 +
    options.numbers  - set to true() to display atom
 +
                      numbers
 +
 +
    options.symbols  - set to false() to not display
 +
                      atom symbols
 +
 +
ilya.kuprov@weizmann.ac.il
  
 
==Examples==
 
==Examples==
 +
 
The following figure is produced by /examples/visualisation/hfc_pyrene.m - (left) ellipsoid plot; (right) spherical harmonic plot.
 
The following figure is produced by /examples/visualisation/hfc_pyrene.m - (left) ellipsoid plot; (right) spherical harmonic plot.
  
Line 50: Line 61:
  
 
==Notes==
 
==Notes==
 +
 
Only Gaussian quantum chemistry package is supported at the moment - send an email to [[Ilya Kuprov]] if you are using something else.
 
Only Gaussian quantum chemistry package is supported at the moment - send an email to [[Ilya Kuprov]] if you are using something else.
  
 
==See also==
 
==See also==
 +
 
[[cst_display.m]], [[volplot.m]], [[molplot.m]], [[conmat.m]], [[gparse.m]]
 
[[cst_display.m]], [[volplot.m]], [[molplot.m]], [[conmat.m]], [[gparse.m]]
  
  
 
''Version 2.6, authors: [[Ilya Kuprov]]''
 
''Version 2.6, authors: [[Ilya Kuprov]]''

Revision as of 15:05, 5 April 2026


Draws hyperfine tensors and their eigensystems. Two styles are implemented:

A. Ellipsoids (symmetric tensors only)
1. 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 HFC tensor in units of milliTesla.
2. A set of axes is drawn inside the sphere with a red axis for a positive eigenvalue, and a blue axis for a negative one.
3. The sphere is translated to the point of corresponding nucleus and rotated into the molecular frame of reference.
B. Spherical harmonics (default)
1. The matrix is converted into irreducible spherical tensor operator coefficients.
2. The coefficients are placed in front of the corresponding spherical harmonics, which are plotted in three dimensions and translated to the point of the corresponding nucleus.

Syntax

hfc_display(props,atoms,scaling,conmatrix,options)

Arguments

props - output of gparse.m function

              atoms - a cell array of element symbols
                      or a vector of integers, indica-
                      ting the atoms for which hyper-
                      fine tensors should be visuali-
                      sed, e.g. {'C','H'} or [1 2 5]
            scaling - a factor to scale the tensors
                      by for visualisation
          conmatrix - binary connectivity matrix, 1
                      if a pair of atoms should be
                      connected by a bond. If an em-
                      pty vector is supplied, 1.6
                      Angstrom cutoff distance is used
      options.style - 'ellipsoids' or 'harmonics'
   options.kill_iso - set to true() to eliminate the
                      isotropic parts of tensors be-
                      fore plotting
   options.numbers  - set to true() to display atom
                      numbers
   options.symbols  - set to false() to not display
                      atom symbols
ilya.kuprov@weizmann.ac.il

Examples

The following figure is produced by /examples/visualisation/hfc_pyrene.m - (left) ellipsoid plot; (right) spherical harmonic plot.

Hfc pyrene.png

Notes

Only Gaussian quantum chemistry package is supported at the moment - send an email to Ilya Kuprov if you are using something else.

See also

cst_display.m, volplot.m, molplot.m, conmat.m, gparse.m


Version 2.6, authors: Ilya Kuprov