AbstractDeformations.h

/***************************************************************************************
*                                                                                      *
*                                     Deformetrica                                     *
*                                                                                      *
*    Copyright Inria and the University of Utah.  All rights reserved. This file is    *
*    distributed under the terms of the Inria Non-Commercial License Agreement.        *
*                                                                                      *
*                                                                                      *
****************************************************************************************/

#ifndef _AbstractDeformations_h
#define _AbstractDeformations_h

#include "vnl/vnl_matrix.h"

#include <vector>


template <class TScalar, unsigned int Dimension>
class AbstractDeformations
{
public:

      // typedef :

      typedef enum
      {
            null,             
            Diffeos                 
      } DeformationsType;

      typedef vnl_vector<TScalar> VNLVectorType;
      typedef vnl_matrix<TScalar> VNLMatrixType;
      typedef std::vector<VNLMatrixType> VNLMatrixList;



      // Constructor(s) / Destructor :

      AbstractDeformations();
      AbstractDeformations(const AbstractDeformations& other);

      virtual AbstractDeformations* Clone() = 0;

      virtual ~AbstractDeformations();



      // Encapsulation method(s) :

      inline bool isADiffeo() const { return (m_Type == Diffeos); }
      inline void SetDiffeosType() { m_Type = Diffeos; }

      inline unsigned int GetNumberOfTimePoints() const { return m_NumberOfTimePoints; }
      inline void SetNumberOfTimePoints(unsigned int n) { m_NumberOfTimePoints = n; m_Modified = true;}

      inline TScalar GetKernelWidth() const { return m_KernelWidth; }
      inline void SetKernelWidth(TScalar kernelWidth) { m_KernelWidth = kernelWidth; m_Modified = true; }

      inline void SetStartPositions(const VNLMatrixType& X) { m_StartPositions = X; m_Modified = true; }

      inline void SetStartMomentas(const VNLMatrixType& A) { m_StartMomentas = A; m_Modified = true; }

      inline VNLMatrixList GetTrajectoryPositions() const { return m_PositionsT; }

      inline VNLMatrixList GetTrajectoryMomentas() const { return m_MomentasT; }

      inline bool ImprovedEuler() const { return m_UseImprovedEuler; }
      void UseStandardEuler() { m_UseImprovedEuler = false; m_Modified = true; }
      void UseImprovedEuler() { m_UseImprovedEuler = true; m_Modified = true; }

      inline VNLMatrixType GetDataDomain() const { return m_DataDomain; }
      inline void SetDataDomain(VNLMatrixType& domain) { m_DataDomain = domain; }

      inline bool OutOfBox() const { return m_OutOfBox; }

      inline TScalar GetPaddingFactor() const { return m_PaddingFactor; }
      inline void SetPaddingFactor(TScalar paddingFactor) { m_PaddingFactor = paddingFactor; }

      inline bool IsModified() const { return m_Modified; }
      inline void SetModified() { m_Modified = true; }
      inline void UnsetModified() { m_Modified = false; }



      // Other method(s) :

      bool CheckBoundingBox(VNLMatrixList& X, int t);

      virtual void Update();

      virtual void ReverseFlow() = 0;



protected:

      // Method(s) :

      virtual void Shoot() = 0;

      void InitBoundingBox();



      // Attribute(s)

      DeformationsType m_Type;

      unsigned int m_NumberOfTimePoints;

      VNLMatrixType m_StartPositions;

      VNLMatrixType m_StartMomentas;

      VNLMatrixType m_DataDomain;

      TScalar m_KernelWidth;

      VNLMatrixList m_PositionsT;

      VNLMatrixList m_MomentasT;

      bool m_UseImprovedEuler;

      bool m_Modified;

      bool m_OutOfBox;

      TScalar m_PaddingFactor;

      VNLMatrixType m_BoundingBox;



}; /* class AbstractDeformations */


#ifndef MU_MANUAL_INSTANTIATION
#include "AbstractDeformations.txx"
#endif


#endif /* _AbstractDeformations_h */