ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | List of all members
itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix > Class Template Reference

#include <itkSymmetricEigenAnalysis.h>

+ Inheritance diagram for itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >:
+ Collaboration diagram for itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >:

Public Types

using EigenMatrixType = TEigenMatrix
 
using EigenValueOrderType = EigenValueOrderEnum
 
using MatrixType = TMatrix
 
using VectorType = TVector
 

Public Member Functions

unsigned int ComputeEigenValues (const TMatrix &A, TVector &EigenValues) const
 
unsigned int ComputeEigenValuesAndVectors (const TMatrix &A, TVector &EigenValues, TEigenMatrix &EigenVectors) const
 
unsigned int GetOrder () const
 
void SetOrder (const unsigned int n)
 
 SymmetricEigenAnalysis ()
 
 SymmetricEigenAnalysis (const unsigned int dimension)
 
 ~SymmetricEigenAnalysis ()=default
 
bool m_UseEigenLibrary { false }
 
unsigned int m_Dimension { 0 }
 
unsigned int m_Order { 0 }
 
EigenValueOrderType m_OrderEigenValues
 
void SetOrderEigenValues (const bool b)
 
bool GetOrderEigenValues () const
 
void SetOrderEigenMagnitudes (const bool b)
 
bool GetOrderEigenMagnitudes () const
 
void SetDimension (const unsigned int n)
 
unsigned int GetDimension () const
 
void SetUseEigenLibrary (const bool input)
 
void SetUseEigenLibraryOn ()
 
void SetUseEigenLibraryOff ()
 
bool GetUseEigenLibrary () const
 
void ReduceToTridiagonalMatrix (double *inputMatrix, double *d, double *e, double *e2) const
 
void ReduceToTridiagonalMatrixAndGetTransformation (double *inputMatrix, double *diagonalElements, double *subDiagonalElements, double *transformMatrix) const
 
unsigned int ComputeEigenValuesUsingQL (double *d, double *e) const
 
unsigned int ComputeEigenValuesAndVectorsUsingQL (double *d, double *e, double *z) const
 
unsigned int ComputeEigenValuesLegacy (const TMatrix &A, TVector &EigenValues) const
 
unsigned int ComputeEigenValuesAndVectorsLegacy (const TMatrix &A, TVector &EigenValues, TEigenMatrix &EigenVectors) const
 
template<typename QMatrix = TMatrix>
auto GetMatrixValueType (bool) const -> typename QMatrix::element_type
 
template<typename QMatrix = TMatrix>
auto GetMatrixValueType (...) const -> typename QMatrix::ValueType
 
unsigned int ComputeEigenValuesAndVectorsWithEigenLibrary (const TMatrix &A, TVector &EigenValues, TEigenMatrix &EigenVectors) const
 
template<typename QMatrix >
auto ComputeEigenValuesAndVectorsWithEigenLibraryImpl (const QMatrix &A, TVector &EigenValues, TEigenMatrix &EigenVectors, long) const -> decltype(static_cast< unsigned int >(1))
 
template<typename QMatrix >
auto ComputeEigenValuesAndVectorsWithEigenLibraryImpl (const QMatrix &A, TVector &EigenValues, TEigenMatrix &EigenVectors, bool) const -> decltype(GetPointerToMatrixData(A), static_cast< unsigned int >(1))
 
unsigned int ComputeEigenValuesWithEigenLibrary (const TMatrix &A, TVector &EigenValues) const
 
template<typename QMatrix >
auto ComputeEigenValuesWithEigenLibraryImpl (const QMatrix &A, TVector &EigenValues, long) const -> decltype(static_cast< unsigned int >(1))
 
template<typename QMatrix >
auto ComputeEigenValuesWithEigenLibraryImpl (const QMatrix &A, TVector &EigenValues, bool) const -> decltype(GetPointerToMatrixData(A), static_cast< unsigned int >(1))
 

Detailed Description

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
class itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >

Find Eigen values of a real 2D symmetric matrix. It serves as a thread-safe alternative to the class: vnl_symmetric_eigensystem, which uses netlib routines.

The class is templated over the input matrix (which is expected to provide access to its elements with the [][] operator), matrix to store eigen values (must provide write operations on its elements with the [] operator), and EigenMatrix to store eigen vectors (must provide write access to its elements with the [][] operator).

The SetOrderEigenValues() method can be used to order eigen values (and their corresponding eigen vectors if computed) in ascending order. This is the default ordering scheme. Eigen vectors and values can be obtained without ordering by calling SetOrderEigenValues(false).

The SetOrderEigenMagnitudes() method can be used to order eigen values (and their corresponding eigen vectors if computed) by magnitude in ascending order.

The user of this class is explicitly supposed to set the dimension of the 2D matrix using the SetDimension() method.

The class contains routines taken from netlib sources (www.netlib.org). netlib/tql1.c netlib/tql2.c netlib/tred1.c netlib/tred2.c

Reference: num. math. 11, 293-306(1968) by bowdler, martin, reinsch, and wilkinson. handbook for auto. comp., vol.ii-linear algebra, 227-240(1971).

Definition at line 166 of file itkSymmetricEigenAnalysis.h.

Member Typedef Documentation

◆ EigenMatrixType

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
using itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::EigenMatrixType = TEigenMatrix

Definition at line 194 of file itkSymmetricEigenAnalysis.h.

◆ EigenValueOrderType

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
using itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::EigenValueOrderType = EigenValueOrderEnum

Enables reverse compatibility for enumeration values

Definition at line 170 of file itkSymmetricEigenAnalysis.h.

◆ MatrixType

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
using itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::MatrixType = TMatrix

Definition at line 193 of file itkSymmetricEigenAnalysis.h.

◆ VectorType

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
using itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::VectorType = TVector

Definition at line 195 of file itkSymmetricEigenAnalysis.h.

Constructor & Destructor Documentation

◆ SymmetricEigenAnalysis() [1/2]

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SymmetricEigenAnalysis ( )
inline

Definition at line 179 of file itkSymmetricEigenAnalysis.h.

◆ SymmetricEigenAnalysis() [2/2]

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SymmetricEigenAnalysis ( const unsigned int  dimension)
inline

Definition at line 183 of file itkSymmetricEigenAnalysis.h.

◆ ~SymmetricEigenAnalysis()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::~SymmetricEigenAnalysis ( )
default

Member Function Documentation

◆ ComputeEigenValues()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValues ( const TMatrix &  A,
TVector &  EigenValues 
) const

Compute Eigen values of A A is any type that overloads the [][] operator and contains the symmetric matrix. In practice only the upper triangle of the matrix will be accessed. (Both itk::Matrix and vnl_matrix overload [][] operator.)

'EigenValues' is any type that overloads the [][] operator and will contain the eigen values.

No size checking is performed. A is expected to be a square matrix of size m_Dimension. 'EigenValues' is expected to be of length m_Dimension. The matrix is not checked to see if it is symmetric.

Referenced by itk::Functor::SymmetricEigenAnalysisFunction< TInputImage::PixelType, TOutputImage::PixelType >::operator()().

◆ ComputeEigenValuesAndVectors()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesAndVectors ( const TMatrix &  A,
TVector &  EigenValues,
TEigenMatrix &  EigenVectors 
) const

Compute Eigen values and vectors of A A is any type that overloads the [][] operator and contains the symmetric matrix. In practice only the upper triangle of the matrix will be accessed. (Both itk::Matrix and vnl_matrix overload [][] operator.)

'EigenValues' is any type that overloads the [] operator and will contain the eigen values.

'EigenVectors' is any type that provides access to its elements with the [][] operator. It is expected be of size m_Dimension * m_Dimension.

No size checking is performed. A is expected to be a square matrix of size m_Dimension. 'EigenValues' is expected to be of length m_Dimension. The matrix is not checked to see if it is symmetric.

Each row of the matrix 'EigenVectors' represents an eigen vector. (unlike MATLAB where the columns of the [EigenVectors, EigenValues] = eig(A) contains the eigenvectors).

◆ ComputeEigenValuesAndVectorsLegacy()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesAndVectorsLegacy ( const TMatrix &  A,
TVector &  EigenValues,
TEigenMatrix &  EigenVectors 
) const
private

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

◆ ComputeEigenValuesAndVectorsUsingQL()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesAndVectorsUsingQL ( double *  d,
double *  e,
double *  z 
) const
private

Finds the eigenvalues and eigenvectors of a symmetric tridiagonal matrix by the ql method.

On input: 'd' contains the diagonal elements of the input matrix. 'e' contains the subdiagonal elements of the input matrix in its last n-1 positions. e(1) is arbitrary. 'z' contains the transformation matrix produced in the reduction by ReduceToTridiagonalMatrixAndGetTransformation(), if performed. If the eigenvectors of the tridiagonal matrix are desired, z must contain the identity matrix.

On Output: 'd' contains the eigenvalues. 'e' has been destroyed. 'z' contains orthonormal eigenvectors of the symmetric tridiagonal (or full) matrix.

Returns: zero for normal return, j if the j-th eigenvalue has not been determined after 1000 iterations.

Reference This subroutine is a translation of the algol procedure tql1, num. math. 11, 293-306(1968) by bowdler, martin, reinsch, and wilkinson. handbook for auto. comp., vol.ii-linear algebra, 227-240(1971).

Questions and comments should be directed to Burton s. Garbow, Mathematics and Computer Science Div., Argonne National Laboratory. This version dated august 1983.

Function Adapted from netlib/tql2.c. [Changed: remove static vars, enforce const correctness. Use vnl routines as necessary]

◆ ComputeEigenValuesAndVectorsWithEigenLibrary()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesAndVectorsWithEigenLibrary ( const TMatrix &  A,
TVector &  EigenValues,
TEigenMatrix &  EigenVectors 
) const
inlineprivate

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 508 of file itkSymmetricEigenAnalysis.h.

◆ ComputeEigenValuesAndVectorsWithEigenLibraryImpl() [1/2]

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
template<typename QMatrix >
auto itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesAndVectorsWithEigenLibraryImpl ( const QMatrix &  A,
TVector &  EigenValues,
TEigenMatrix &  EigenVectors,
bool   
) const -> decltype(GetPointerToMatrixData(A), static_cast<unsigned int>(1))
inlineprivate

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 589 of file itkSymmetricEigenAnalysis.h.

◆ ComputeEigenValuesAndVectorsWithEigenLibraryImpl() [2/2]

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
template<typename QMatrix >
auto itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesAndVectorsWithEigenLibraryImpl ( const QMatrix &  A,
TVector &  EigenValues,
TEigenMatrix &  EigenVectors,
long   
) const -> decltype(static_cast<unsigned int>(1))
inlineprivate

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 523 of file itkSymmetricEigenAnalysis.h.

◆ ComputeEigenValuesLegacy()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesLegacy ( const TMatrix &  A,
TVector &  EigenValues 
) const
private

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

◆ ComputeEigenValuesUsingQL()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesUsingQL ( double *  d,
double *  e 
) const
private

Finds the eigenvalues of a symmetric tridiagonal matrix by the ql method.

On input: 'd' contains the diagonal elements of the input matrix. 'e' contains the subdiagonal elements of the input matrix in its last n-1 positions. e(1) is arbitrary. On Output: 'd' contains the eigenvalues. 'e' has been destroyed.

Returns: zero for normal return, j if the j-th eigenvalue has not been determined after 30 iterations.

Reference This subroutine is a translation of the algol procedure tql1, num. math. 11, 293-306(1968) by bowdler, martin, reinsch, and wilkinson. handbook for auto. comp., vol.ii-linear algebra, 227-240(1971).

Questions and comments should be directed to Burton s. Garbow, Mathematics and Computer Science Div., Argonne National Laboratory. This version dated august 1983.

Function Adapted from netlib/tql1.c. [Changed: remove static vars, enforce const correctness. Use vnl routines as necessary]

◆ ComputeEigenValuesWithEigenLibrary()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesWithEigenLibrary ( const TMatrix &  A,
TVector &  EigenValues 
) const
inlineprivate

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 641 of file itkSymmetricEigenAnalysis.h.

◆ ComputeEigenValuesWithEigenLibraryImpl() [1/2]

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
template<typename QMatrix >
auto itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesWithEigenLibraryImpl ( const QMatrix &  A,
TVector &  EigenValues,
bool   
) const -> decltype(GetPointerToMatrixData(A), static_cast<unsigned int>(1))
inlineprivate

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 694 of file itkSymmetricEigenAnalysis.h.

◆ ComputeEigenValuesWithEigenLibraryImpl() [2/2]

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
template<typename QMatrix >
auto itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ComputeEigenValuesWithEigenLibraryImpl ( const QMatrix &  A,
TVector &  EigenValues,
long   
) const -> decltype(static_cast<unsigned int>(1))
inlineprivate

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 654 of file itkSymmetricEigenAnalysis.h.

◆ GetDimension()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::GetDimension ( ) const
inline

Get Matrix dimension, Will be 0 unless explicitly set by a call to SetDimension.

Definition at line 315 of file itkSymmetricEigenAnalysis.h.

Referenced by itk::Functor::SymmetricEigenAnalysisFunction< TInputImage::PixelType, TOutputImage::PixelType >::GetDimension(), and itk::operator<<().

◆ GetMatrixValueType() [1/2]

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
template<typename QMatrix = TMatrix>
auto itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::GetMatrixValueType (   ...) const -> typename QMatrix::ValueType
inlineprivate

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 501 of file itkSymmetricEigenAnalysis.h.

◆ GetMatrixValueType() [2/2]

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
template<typename QMatrix = TMatrix>
auto itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::GetMatrixValueType ( bool  ) const -> typename QMatrix::element_type
inlineprivate

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 495 of file itkSymmetricEigenAnalysis.h.

◆ GetOrder()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::GetOrder ( ) const
inline

Get the Matrix order. Will be 0 unless explicitly set, or unless a call to SetDimension has been made in which case it will be the matrix dimension.

Definition at line 248 of file itkSymmetricEigenAnalysis.h.

Referenced by itk::operator<<().

◆ GetOrderEigenMagnitudes()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
bool itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::GetOrderEigenMagnitudes ( ) const
inline

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 294 of file itkSymmetricEigenAnalysis.h.

Referenced by itk::operator<<().

◆ GetOrderEigenValues()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
bool itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::GetOrderEigenValues ( ) const
inline

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 271 of file itkSymmetricEigenAnalysis.h.

Referenced by itk::operator<<().

◆ GetUseEigenLibrary()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
bool itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::GetUseEigenLibrary ( ) const
inline

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 337 of file itkSymmetricEigenAnalysis.h.

Referenced by itk::operator<<().

◆ ReduceToTridiagonalMatrix()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ReduceToTridiagonalMatrix ( double *  inputMatrix,
double *  d,
double *  e,
double *  e2 
) const
private

Reduces a real symmetric matrix to a symmetric tridiagonal matrix using orthogonal similarity transformations. 'inputMatrix' contains the real symmetric input matrix. Only the lower triangle of the matrix need be supplied. The upper triangle is unaltered. 'd' contains the diagonal elements of the tridiagonal matrix. 'e' contains the subdiagonal elements of the tridiagonal matrix in its last n-1 positions. e(1) is set to zero. 'e2' contains the squares of the corresponding elements of e. 'e2' may coincide with e if the squares are not needed. questions and comments should be directed to burton s. garbow. mathematics and computer science div, argonne national laboratory this version dated august 1983.

Function adapted from netlib/tred1.c. [Changed: remove static vars, enforce const correctness. Use vnl routines as necessary]. Reference: num. math. 11, 181-195(1968) by martin, reinsch, and wilkinson. handbook for auto. comp., vol.ii-linear algebra, 212-226(1971).

◆ ReduceToTridiagonalMatrixAndGetTransformation()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::ReduceToTridiagonalMatrixAndGetTransformation ( double *  inputMatrix,
double *  diagonalElements,
double *  subDiagonalElements,
double *  transformMatrix 
) const
private

Reduces a real symmetric matrix to a symmetric tridiagonal matrix using and accumulating orthogonal similarity transformations. 'inputMatrix' contains the real symmetric input matrix. Only the lower triangle of the matrix need be supplied. The upper triangle is unaltered. 'diagonalElements' will contains the diagonal elements of the tridiagonal matrix. 'subDiagonalElements' will contain the subdiagonal elements of the tridiagonal matrix in its last n-1 positions. subDiagonalElements(1) is set to zero. 'transformMatrix' contains the orthogonal transformation matrix produced in the reduction.

Questions and comments should be directed to Burton s. Garbow, Mathematics and Computer Science Div., Argonne National Laboratory. This version dated august 1983.

Function adapted from netlib/tred2.c. [Changed: remove static vars, enforce const correctness. Use vnl routines as necessary]. Reference: num. math. 11, 181-195(1968) by martin, reinsch, and wilkinson. handbook for auto. comp., vol.ii-linear algebra, 212-226(1971).

◆ SetDimension()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SetDimension ( const unsigned int  n)
inline

Set the dimension of the input matrix A. A is a square matrix of size m_Dimension.

Definition at line 302 of file itkSymmetricEigenAnalysis.h.

Referenced by itk::Functor::SymmetricEigenAnalysisFunction< TInputImage::PixelType, TOutputImage::PixelType >::SetDimension().

◆ SetOrder()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SetOrder ( const unsigned int  n)
inline

Matrix order. Defaults to matrix dimension if not set

Definition at line 239 of file itkSymmetricEigenAnalysis.h.

◆ SetOrderEigenMagnitudes()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SetOrderEigenMagnitudes ( const bool  b)
inline

Set/Get methods to order the eigen value magnitudes in ascending order. In other words, |lambda_1| < |lambda_2| < .....

Definition at line 280 of file itkSymmetricEigenAnalysis.h.

Referenced by itk::Functor::SymmetricEigenAnalysisFunction< TInputImage::PixelType, TOutputImage::PixelType >::OrderEigenValuesBy().

◆ SetOrderEigenValues()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SetOrderEigenValues ( const bool  b)
inline

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 257 of file itkSymmetricEigenAnalysis.h.

Referenced by itk::Functor::SymmetricEigenAnalysisFunction< TInputImage::PixelType, TOutputImage::PixelType >::OrderEigenValuesBy().

◆ SetUseEigenLibrary()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SetUseEigenLibrary ( const bool  input)
inline

Set/Get to use Eigen library instead of vnl/netlib.

Definition at line 322 of file itkSymmetricEigenAnalysis.h.

◆ SetUseEigenLibraryOff()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SetUseEigenLibraryOff ( )
inline

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 332 of file itkSymmetricEigenAnalysis.h.

◆ SetUseEigenLibraryOn()

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
void itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::SetUseEigenLibraryOn ( )
inline

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 327 of file itkSymmetricEigenAnalysis.h.

Member Data Documentation

◆ m_Dimension

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::m_Dimension { 0 }
private

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 345 of file itkSymmetricEigenAnalysis.h.

◆ m_Order

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
unsigned int itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::m_Order { 0 }
private

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 346 of file itkSymmetricEigenAnalysis.h.

◆ m_OrderEigenValues

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
EigenValueOrderType itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::m_OrderEigenValues
private

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 347 of file itkSymmetricEigenAnalysis.h.

◆ m_UseEigenLibrary

template<typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix>
bool itk::SymmetricEigenAnalysis< TMatrix, TVector, TEigenMatrix >::m_UseEigenLibrary { false }
private

Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 < lambda_2 < ....

Definition at line 344 of file itkSymmetricEigenAnalysis.h.


The documentation for this class was generated from the following file: