ITK  4.6.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows > Class Template Reference

#include <itkSymmetricEigenSystem.h>

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

Detailed Description

template<typename 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.

Public Types

typedef FixedArray< ArrayType,
VNumberOfRows > 
Array2DType
 
typedef FixedArray
< TMatrixElement,
VNumberOfRows > 
ArrayType
 
typedef SmartPointer< const SelfConstPointer
 
typedef ArrayType EigenValueArrayType
 
typedef Array2DType EigenVectorArrayType
 
typedef
vnl_symmetric_eigensystem
< TMatrixElement > 
InternalEigenSystemType
 
typedef Matrix< TMatrixElement,
VNumberOfRows, VNumberOfRows > 
MatrixType
 
typedef SmartPointer< SelfPointer
 
typedef SymmetricEigenSystem Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
EigenValueArrayTypeGetEigenValues ()
 
EigenVectorArrayTypeGetEigenVectors ()
 
virtual const char * GetNameOfClass () const
 
void Update ()
 
virtual void SetMatrix (MatrixType *_arg)
 
MatrixTypeGetMatrix ()
 
virtual void SetUseAbsoluteOrder (bool _arg)
 
virtual bool GetUseAbsoluteOrder ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void GenerateData ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
 SymmetricEigenSystem ()
 
virtual ~SymmetricEigenSystem ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

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

Private Attributes

EigenValueArrayType m_EigenValues
 
EigenVectorArrayType m_EigenVectors
 
MatrixTypem_Matrix
 
bool m_UseAbsoluteOrder
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

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

2D array typedef

Definition at line 66 of file itkSymmetricEigenSystem.h.

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

1D array typedef

Definition at line 60 of file itkSymmetricEigenSystem.h.

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

Definition at line 54 of file itkSymmetricEigenSystem.h.

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

Array type for eigen values

Definition at line 72 of file itkSymmetricEigenSystem.h.

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

Array for eigen vectors

Definition at line 69 of file itkSymmetricEigenSystem.h.

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

Internal eigen system type.

Definition at line 78 of file itkSymmetricEigenSystem.h.

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

Matrix Type

Definition at line 75 of file itkSymmetricEigenSystem.h.

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

Definition at line 53 of file itkSymmetricEigenSystem.h.

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

Standard "Self" typedef.

Definition at line 51 of file itkSymmetricEigenSystem.h.

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

Definition at line 52 of file itkSymmetricEigenSystem.h.

Constructor & Destructor Documentation

template<typename TMatrixElement , int VNumberOfRows>
itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SymmetricEigenSystem ( )
protected
template<typename TMatrixElement , int VNumberOfRows>
virtual itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::~SymmetricEigenSystem ( )
protectedvirtual
template<typename TMatrixElement , int VNumberOfRows>
itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SymmetricEigenSystem ( const Self )
private

Member Function Documentation

template<typename 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<typename TMatrixElement , int VNumberOfRows>
void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GenerateData ( )
protected

Produces the eigen vectors and values.

Referenced by itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Update().

template<typename 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.

References itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_EigenValues.

template<typename 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.

References itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_EigenVectors.

template<typename 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.

References itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_Matrix.

template<typename 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<typename 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<typename TMatrixElement , int VNumberOfRows>
static Pointer itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::New ( )
static

Method for creation through the object factory.

template<typename TMatrixElement , int VNumberOfRows>
void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::operator= ( const Self )
private
template<typename TMatrixElement , int VNumberOfRows>
virtual void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::Object.

template<typename TMatrixElement , int VNumberOfRows>
virtual void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SetMatrix ( MatrixType _arg)
virtual

Set/Get the target matrix for the eigen analysis

template<typename 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<typename 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.

References itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GenerateData().

Member Data Documentation

template<typename TMatrixElement , int VNumberOfRows>
EigenValueArrayType itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_EigenValues
private
template<typename TMatrixElement , int VNumberOfRows>
EigenVectorArrayType itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_EigenVectors
private
template<typename TMatrixElement , int VNumberOfRows>
MatrixType* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::m_Matrix
private
template<typename 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: