caps.diffusion_estimation.tensor_utils.DecomposeSecondOrderTensor¶

DecomposeSecondOrderTensor¶

class caps.diffusion_estimation.tensor_utils.DecomposeSecondOrderTensor[source]¶: Compute the eigenvalues and eigenvectors of a given diffusion tensor.

$\textbf{D} = [ \vec{e_{1}}, \vec{e_{2}}, \vec{e_{3}} ] diag[\lambda_{1}, \lambda_{2}, \lambda_{3}] [ \vec{e_{1}}, \vec{e_{2}}, \vec{e_{3}} ]^{-t} = \textbf{U} \textbf{V} \textbf{U}^{-t}$

$\textbf{D} = \sum_{i=1}^{3} \lambda_i \vec{e_i} \vec{e_i}^{T}$

[Mandatory]

tensor_file: a file name (mandatory)

a second order tensor model

[Optional]

eigenvals_basename: a string (optional)

the basename of the output eigen values file

eigenvecs_basename: a string (optional)

the basename of the output eigen vectors file

number_of_workers: an integer (optional)

the number of CPUs to use during the execution

output_directory: a directory name (optional)

the output directory where the tensor eigenvalues and eigenvectors

will be written

eigen_values_file: a file name

the name of the output eigen values file

eigen_vectors_file: a file name

the name of the output eigen vectors file