itkSymmetricEigenSystem.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#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< typename TMatrixElement, int VNumberOfRows >
class 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();
  virtual void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;

  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.hxx"
#endif

#endif