cmtkSplineWarpGroupwiseRegistrationRMIFunctional.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: 2398 $
//
//  $LastChangedDate: 2010-10-05 14:54:37 -0700 (Tue, 05 Oct 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkSplineWarpGroupwiseRegistrationRMIFunctional_h_included_
#define __cmtkSplineWarpGroupwiseRegistrationRMIFunctional_h_included_

#include <cmtkconfig.h>

#include <Registration/cmtkGroupwiseRegistrationRMIFunctional.h>

#include <System/cmtkSmartPtr.h>
#include <System/cmtkThreads.h>

#include <Base/cmtkUniformVolume.h>
#include <Base/cmtkSplineWarpXform.h>
#include <Base/cmtkHistogram.h>

#include <IO/cmtkClassStream.h>

#include <vector>

namespace
cmtk
{


class SplineWarpGroupwiseRegistrationRMIFunctional : 
  public GroupwiseRegistrationRMIFunctional<SplineWarpXform>
{
public:
  typedef GroupwiseRegistrationRMIFunctional<SplineWarpXform> Superclass;

  typedef SplineWarpGroupwiseRegistrationRMIFunctional Self;

  typedef SmartPointer<Self> SmartPtr;

  SplineWarpGroupwiseRegistrationRMIFunctional() : 
    m_NeedsUpdateInformationByControlPoint( false ),  
    m_ControlPointScheduleOverlapFreeMaxLength( 0 ) 
  {}

  virtual Self::ReturnType Evaluate();

  virtual Self::ReturnType EvaluateAt( CoordinateVector& v )
  {
    return this->Superclass::EvaluateAt( v );
  }

  virtual Self::ReturnType EvaluateWithGradient( CoordinateVector& v, CoordinateVector& g, const Types::Coordinate step = 1 );

private:
  virtual void UpdateActiveControlPoints();
  
  std::vector<byte> m_InformationByControlPoint;

  bool m_NeedsUpdateInformationByControlPoint;

  virtual void UpdateInformationByControlPoint();

  virtual void UpdateControlPointSchedule();

  std::vector<int> m_ControlPointSchedule;

  size_t m_ControlPointScheduleOverlapFreeMaxLength;

  class EvaluateLocalGradientThreadParameters : 
    public ThreadParameters<Self>
  {
  public:
    size_t m_ThreadStorageIndex;

    Types::Coordinate m_Step;

    Types::Coordinate* m_Gradient;
    
    Self::ReturnType m_MetricBaseValue;

#ifdef CMTK_BUILD_MPI

    size_t m_FirstIndexToCompute;
#endif
  };

  static CMTK_THREAD_RETURN_TYPE EvaluateLocalGradientThreadFunc( void* args );

#ifdef CMTK_BUILD_MPI
  void ReorderGradientComponents( Types::Coordinate *const dst, const Types::Coordinate* src, const size_t fromCpIdx, const size_t toCpIdx );
#endif
};


} // namespace cmtk

#endif // #ifndef __cmtkSplineWarpGroupwiseRegistrationRMIFunctional_h_included_