itkSymmetricEigenSystem.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSymmetricEigenSystem.h,v $
  Language:  C++
  Date:      $Date: 2007-03-22 21:39:38 $
  Version:   $Revision: 1.8 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkSymmetricEigenSystem_h
#define __itkSymmetricEigenSystem_h

#include "itkObject.h"
#include "vnl/algo/vnl_symmetric_eigensystem.h"
#include "itkObjectFactory.h"
#include "itkObject.h"
#include "itkFixedArray.h"
#include "itkMatrix.h"
#include "itkObjectFactory.h"

namespace itk
{
  
template< class TMatrixElement, int VNumberOfRows >
class ITK_EXPORT SymmetricEigenSystem : public Object
{
public:
  typedef SymmetricEigenSystem     Self;
  typedef Object                   Superclass;
  typedef SmartPointer<Self>       Pointer;
  typedef SmartPointer<const Self> ConstPointer;

  itkTypeMacro( SymmetricEigenSystem, Object );

  itkNewMacro(Self);

  typedef FixedArray< TMatrixElement, VNumberOfRows > ArrayType;

  typedef FixedArray< ArrayType, VNumberOfRows > Array2DType;

  typedef Array2DType EigenVectorArrayType;

  typedef ArrayType EigenValueArrayType;

  typedef Matrix< TMatrixElement, VNumberOfRows, VNumberOfRows > MatrixType;

  typedef vnl_symmetric_eigensystem< TMatrixElement > InternalEigenSystemType;

  itkSetObjectMacro(Matrix, MatrixType);
  MatrixType* GetMatrix()
    { return m_Matrix; }

  itkSetMacro(UseAbsoluteOrder, bool);
  itkGetMacro(UseAbsoluteOrder, bool);

  EigenVectorArrayType* GetEigenVectors()
  { return &m_EigenVectors; } 

  EigenValueArrayType* GetEigenValues()
  { return &m_EigenValues; }

  void Update()
  { this->GenerateData(); }

protected:
  SymmetricEigenSystem();
  virtual ~SymmetricEigenSystem();
  void PrintSelf(std::ostream& os, Indent indent) const;

  void GenerateData();

private:
  SymmetricEigenSystem(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  MatrixType* m_Matrix;

  EigenVectorArrayType m_EigenVectors;

  EigenValueArrayType m_EigenValues;

  bool m_UseAbsoluteOrder;
};

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkSymmetricEigenSystem.txx"
#endif

#endif