ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows > Class Template Reference
Numerics | Deprecated classes that are scheduled to be removed from the Toolkit | Module ITKEigen

#include <itkSymmetricEigenSystem.h>

+ Inheritance diagram for itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >:
+ Collaboration diagram for itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >:

List of all members.

Public Types

typedef FixedArray< ArrayType,
VNumberOfRows > 		Array2DType
typedef FixedArray
< TMatrixElement,
VNumberOfRows > 		ArrayType
typedef SmartPointer< const Self > ConstPointer
typedef ArrayType EigenValueArrayType
typedef Array2DType EigenVectorArrayType
typedef
vnl_symmetric_eigensystem
< TMatrixElement > 		InternalEigenSystemType
typedef Matrix< TMatrixElement,
VNumberOfRows, VNumberOfRows > 		MatrixType
typedef SmartPointer< Self > Pointer
typedef SymmetricEigenSystem Self
typedef Object Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
EigenValueArrayType * GetEigenValues ()
EigenVectorArrayType * GetEigenVectors ()
virtual const char * GetNameOfClass () const
virtual void SetMatrix (MatrixType *_arg)
MatrixType * GetMatrix ()
virtual void SetUseAbsoluteOrder (bool _arg)
virtual bool GetUseAbsoluteOrder ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void GenerateData ()

Private Member Functions

void operator= (const Self &)
 SymmetricEigenSystem (const Self &)

Private Attributes

EigenValueArrayType m_EigenValues
EigenVectorArrayType m_EigenVectors
MatrixType * m_Matrix
bool m_UseAbsoluteOrder
void Update ()
 SymmetricEigenSystem ()
virtual ~SymmetricEigenSystem ()
void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<class TMatrixElement, int VNumberOfRows>
class itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >

wrapper of the vnl_symmetric_eigensystem algorithm

This class is not thread-safe. If you are interested in thread-safety please use the class SymmetricEigenAnalysis in Insight/Code/Common.

Warning:
THIS CLASS IS DEPRECATED AND IT IS SCHEDULED FOR BEING REMOVED FROM THE TOOLKIT IN RELEASE 2.4
See also:
SymmetricEigenAnalysis

Definition at line 47 of file itkSymmetricEigenSystem.h.

Member Typedef Documentation

template<class TMatrixElement , int VNumberOfRows>
typedef FixedArray< ArrayType, VNumberOfRows > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Array2DType

2D array typedef

Definition at line 66 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef FixedArray< TMatrixElement, VNumberOfRows > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::ArrayType

1D array typedef

Definition at line 60 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef SmartPointer< const Self > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::ConstPointer

Reimplemented from itk::Object.

Definition at line 54 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef ArrayType itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::EigenValueArrayType

Array type for eigen values

Definition at line 72 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef Array2DType itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::EigenVectorArrayType

Array for eigen vectors

Definition at line 69 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef vnl_symmetric_eigensystem< TMatrixElement > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::InternalEigenSystemType

Internal eigen sytem type.

Definition at line 78 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef Matrix< TMatrixElement, VNumberOfRows, VNumberOfRows > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::MatrixType

Matrix Type

Definition at line 75 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef SmartPointer< Self > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Pointer

Reimplemented from itk::Object.

Definition at line 53 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef SymmetricEigenSystem itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Self

Standard "Self" typedef.

Reimplemented from itk::Object.

Definition at line 51 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
typedef Object itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Superclass

Reimplemented from itk::Object.

Definition at line 52 of file itkSymmetricEigenSystem.h.

Constructor & Destructor Documentation

template<class TMatrixElement , int VNumberOfRows>
itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SymmetricEigenSystem ( ) [protected]

dummy method that calls the GenerateData method to produce the eigen vectors and values.

template<class TMatrixElement , int VNumberOfRows>
virtual itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::~SymmetricEigenSystem ( ) [protected, virtual]

dummy method that calls the GenerateData method to produce the eigen vectors and values.

template<class TMatrixElement , int VNumberOfRows>
itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SymmetricEigenSystem ( const Self &  ) [private]

Member Function Documentation

template<class TMatrixElement , int VNumberOfRows>
virtual::itk::LightObject::Pointer itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TMatrixElement , int VNumberOfRows>
void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GenerateData ( ) [protected]

Produces the eigen vectors and values.

template<class TMatrixElement , int VNumberOfRows>
EigenValueArrayType* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetEigenValues ( ) [inline]

returns the eigen values in an 1D array

Definition at line 101 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
EigenVectorArrayType* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetEigenVectors ( ) [inline]

returns the eigen vectors in a 2D array

Definition at line 97 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
MatrixType* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetMatrix ( void  ) [inline]

Set/Get the target matrix for the eigen analysis

Definition at line 82 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
virtual const char* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<class TMatrixElement , int VNumberOfRows>
virtual bool itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetUseAbsoluteOrder ( ) [virtual]

Set/Get the absolute order flag. By setting this flag true, after the calculation of eigen vectors and values, if the absolute eigen value of eigen vector[j > i] is greater that of eigen vector[i], reorder the eigen vectors so that every absolute eigen values of eigen vector[j < i] is always greater than or equal to that of the eigen vectors[i]

template<class TMatrixElement , int VNumberOfRows>
static Pointer itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TMatrixElement , int VNumberOfRows>
void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::operator= ( const Self &  ) [private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

template<class TMatrixElement , int VNumberOfRows>
void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

dummy method that calls the GenerateData method to produce the eigen vectors and values.

Reimplemented from itk::Object.

template<class TMatrixElement , int VNumberOfRows>
virtual void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SetMatrix ( MatrixType *  _arg) [virtual]

Set/Get the target matrix for the eigen analysis

template<class TMatrixElement , int VNumberOfRows>
virtual void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SetUseAbsoluteOrder ( bool  _arg) [virtual]

Set/Get the absolute order flag. By setting this flag true, after the calculation of eigen vectors and values, if the absolute eigen value of eigen vector[j > i] is greater that of eigen vector[i], reorder the eigen vectors so that every absolute eigen values of eigen vector[j < i] is always greater than or equal to that of the eigen vectors[i]

template<class TMatrixElement , int VNumberOfRows>
void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Update ( void  ) [inline]

dummy method that calls the GenerateData method to produce the eigen vectors and values.

Definition at line 106 of file itkSymmetricEigenSystem.h.

Member Data Documentation

template<class TMatrixElement , int VNumberOfRows>
EigenValueArrayType itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_EigenValues [private]

eigen values output

Definition at line 128 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
EigenVectorArrayType itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_EigenVectors [private]

eigen vectors output

Definition at line 125 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
MatrixType* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_Matrix [private]

the target matrix

Definition at line 122 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement , int VNumberOfRows>
bool itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_UseAbsoluteOrder [private]

flag for absolute ordering of eigen vectors and eigen values

Definition at line 132 of file itkSymmetricEigenSystem.h.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 01:44:09 for ITK by doxygen 1.7.6.1