cmtkGroupwiseRegistrationFunctionalXformTemplate_SplineWarp.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2010 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 1768 $
//
//  $LastChangedDate: 2010-05-27 15:16:01 -0700 (Thu, 27 May 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkGroupwiseRegistrationFunctionalXformTemplate_SplineWarp_h_included_
#define __cmtkGroupwiseRegistrationFunctionalXformTemplate_SplineWarp_h_included_

#include <Base/cmtkSplineWarpXform.h>

namespace
cmtk
{

template<>
class GroupwiseRegistrationFunctionalXformTemplate<SplineWarpXform> : 
  public GroupwiseRegistrationFunctionalXformTemplateBase<SplineWarpXform>
{
public:
  typedef GroupwiseRegistrationFunctionalXformTemplateBase<SplineWarpXform> Superclass;
  
  typedef GroupwiseRegistrationFunctionalXformTemplate<SplineWarpXform> Self;

  typedef SmartPointer<Self> SmartPtr;

  GroupwiseRegistrationFunctionalXformTemplate();

  virtual ~GroupwiseRegistrationFunctionalXformTemplate() {};

  virtual void InitializeXformsFromAffine( const Types::Coordinate gridSpacing, 
                                           std::vector<AffineXform::SmartPtr> initialAffineXformsVector, 
                                           const bool exactSpacing = true 
    );
  
  virtual void InitializeXforms( const Types::Coordinate gridSpacing, 
                                 const bool exactSpacing = true  
    )
  {
    this->InitializeXformsFromAffine( gridSpacing, this->m_InitialAffineXformsVector, exactSpacing );
  }
  
  virtual void RefineTransformationGrids();

  void SetForceZeroSumNoAffine( const bool noaffine = true )
  {
    this->m_ForceZeroSumNoAffine = noaffine;
  }

  void SetPartialGradientMode( const bool partialGradientMode = false, const float partialGradientThreshold = 0.0 )
  {
    this->m_PartialGradientMode = partialGradientMode;
    this->m_PartialGradientThreshold = partialGradientThreshold;
  }

  void SetDeactivateUninformativeMode( const bool dum = true )
  {
    this->m_DeactivateUninformativeMode = dum;
  }

  virtual void SetActiveXformsFromTo( const size_t from, const size_t to )
  {
    this->Superclass::SetActiveXformsFromTo( from, to );
    this->UpdateParamStepArray();
  }

  virtual void SetTemplateGrid( UniformVolume::SmartPtr& templateGrid, const int downsample = 1, const bool useTemplateData = false );
    
protected:
  size_t m_MaximumNumberOfPixelsVOI;
  
  size_t m_MaximumNumberOfPixelsPerLineVOI;

  virtual void UpdateVolumesOfInfluence();

  virtual void UpdateActiveControlPoints() = 0;
  
  virtual void InterpolateImage( const size_t idx, byte* const destination );

  virtual void ForceZeroSumGradient( CoordinateVector& g ) const;

  bool Wiggle();

protected:
  bool m_ForceZeroSumNoAffine;

  bool m_WarpFastMode;

  float m_JacobianConstraintWeight;

  float m_BendingEnergyWeight;

  bool m_PartialGradientMode;

  std::vector<AffineXform::SmartPtr> m_InitialAffineXformsVector;

  std::vector<AffineXform::SmartPtr> m_InitialRotationsVector;

  std::vector<Types::Coordinate> m_ParamStepArray;

  virtual bool UpdateParamStepArray();

  std::vector<DataGrid::RegionType> m_VolumeOfInfluenceArray;

  Types::Coordinate m_PartialGradientThreshold;

  bool m_DeactivateUninformativeMode;

  std::vector<bool> m_ActiveControlPointFlags;

  size_t m_NumberOfActiveControlPoints;

private:
  class InterpolateImageThreadParameters : 
    public ThreadParameters<Self>
  {
  public:
    size_t m_Idx;

    byte* m_Destination;
  };

  static void InterpolateImageThread( void* args, const size_t taskIdx, const size_t taskCnt, const size_t, const size_t );

  friend ClassStream& operator<<( ClassStream& stream, const GroupwiseRegistrationFunctionalXformTemplate<SplineWarpXform>& func );
  friend ClassStream& operator>>( ClassStream& stream, GroupwiseRegistrationFunctionalXformTemplate<SplineWarpXform>& func );
};

ClassStream& operator<<( ClassStream& stream, const GroupwiseRegistrationFunctionalXformTemplate<SplineWarpXform>& func );
ClassStream& operator>>( ClassStream& stream, GroupwiseRegistrationFunctionalXformTemplate<SplineWarpXform>& func );

} // namespace cmtk

#endif // #ifndef __cmtkGroupwiseRegistrationFunctionalXformTemplate_SplineWarp_h_included_