[frames] | no frames]

# Module main

source code

Module for the support of diffusion tensors.

 Functions

 return_eigenvalues() Function for returning Dx, Dy, and Dz. source code
3D rank-1 array, 3D rank-2 array, float, float, float
 tensor_eigen_system(tensor) Determine the eigenvalues and vectors for the tensor, sorting the entries. source code

 tensor_info_table(type=None, tm=None, Diso=None, Da=None, Dpar=None, Dper=None, Dratio=None, Dr=None, Dx=None, Dy=None, Dz=None, theta=None, phi=None, alpha=None, beta=None, gamma=None, fixed=None) Print out details of the diffusion tensor. source code
 Variables
__package__ = `'lib.diffusion'`

Imports: pi, cross, float64, transpose, zeros, norm, svd, R_to_euler_zyz, format_table

 Function Details

### tensor_eigen_system(tensor)

source code

Determine the eigenvalues and vectors for the tensor, sorting the entries.

Returns: 3D rank-1 array, 3D rank-2 array, float, float, float
The eigenvalues, rotation matrix, and the Euler angles in zyz notation.

### tensor_info_table(type=None, tm=None, Diso=None, Da=None, Dpar=None, Dper=None, Dratio=None, Dr=None, Dx=None, Dy=None, Dz=None, theta=None, phi=None, alpha=None, beta=None, gamma=None, fixed=None)

source code

Print out details of the diffusion tensor.

Parameters:
• `type` (str) - The diffusion tensor type - one of 'sphere', 'spheroid', or 'ellipsoid'.
• `tm` (float) - The isotropic correlation time in seconds.
• `Diso` (float) - The isotropic diffusion rate.
• `Da` (float or None) - The anisotropic component of the tensor.
• `Dpar` (float or None) - The parallel component of the spheroidal diffusion tensor.
• `Dper` (float or None) - The perpendicular component of the spheroidal diffusion tensor.
• `Dratio` (float or None) - The ratio of Dpar and Dper.
• `Dr` (float or None) - The rhombic component of the diffusion tensor.
• `Dx` (float or None) - The x component of the ellipsoid.
• `Dy` (float or None) - The y component of the ellipsoid.
• `Dz` (float or None) - The z component of the ellipsoid.
• `theta` (float or None) - The azimuthal angle in radians.
• `phi` (float or None) - The polar angle in radians.
• `alpha` (float or None) - The Euler angle alpha in radians using the z-y-z convention.
• `beta` (float or None) - The Euler angle beta in radians using the z-y-z convention.
• `gamma` (float or None) - The Euler angle gamma in radians using the z-y-z convention.

 Generated by Epydoc 3.0.1 on Fri Jun 14 11:29:05 2019 http://epydoc.sourceforge.net