cmtkSplineWarpCongealingFunctional.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 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: 2736 $
//
//  $LastChangedDate: 2011-01-14 10:37:08 -0800 (Fri, 14 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkSplineWarpCongealingFunctional_h_included_
#define __cmtkSplineWarpCongealingFunctional_h_included_

#include <cmtkconfig.h>

#include <Registration/cmtkCongealingFunctional.h>

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

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

#include <IO/cmtkClassStream.h>

#include <vector>

namespace
cmtk
{


class SplineWarpCongealingFunctional : 
  public CongealingFunctional<SplineWarpXform>
{
public:
  typedef CongealingFunctional<SplineWarpXform> Superclass;

  typedef Superclass::HistogramType HistogramType;

  typedef SplineWarpCongealingFunctional Self;

  typedef SmartPointer<Self> SmartPtr;

  virtual void InitializeXformsFromAffine( const Types::Coordinate gridSpacing, 
                                           std::vector<AffineXform::SmartPtr> initialAffineXformsVector, 
                                           const bool exactSpacing = true 
    );

  virtual void RefineTransformationGrids();

  virtual void SetTemplateGrid( UniformVolume::SmartPtr& templateGrid, const int downsample = 1, const bool useTemplateData = false );
    
  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();
  
  virtual void UpdateStandardDeviationByPixel();

  std::vector<double> m_EntropyByPixel;

#ifdef CMTK_BUILD_MPI

  std::vector<double> m_EntropyByPixelMPI;
#endif

  class EvaluateThreadParameters : 
    public ThreadParameters<Self>
  {
  public:
    double m_Entropy;

    unsigned int m_Count;
  };
  
  static void EvaluateThread( void* args, const size_t taskIdx, const size_t taskCnt, const size_t threadIdx, const size_t );

  class EvaluateLocalGradientThreadParameters : 
    public ThreadParameters<Self>
  {
  public:
    Types::Coordinate m_Step;

    Types::Coordinate* m_Gradient;

#ifdef CMTK_BUILD_MPI

    size_t m_FirstIndexToCompute;

#endif
  };

  size_t m_ControlPointIndexNext;

  size_t m_ControlPointIndexLast;
  
  MutexLock m_ControlPointIndexLock;

  class StaticThreadStorage
  {
  public:
    void Initialize( const Self* This );
    
    std::vector<Self::ReturnType> m_FPlus;

    std::vector<Self::ReturnType> m_FMinus;

    std::vector<unsigned int> m_CountByParameterPlus;

    std::vector<unsigned int> m_CountByParameterMinus;

    std::vector<SplineWarpXform::SmartPtr> m_Xforms;

    std::vector<Vector3D> m_VectorList;
    
    std::vector<size_t> m_Count;
    
    std::vector<HistogramType> m_Histogram;

    bool m_NeedToCopyXformParameters;
  };

  std::vector<StaticThreadStorage> m_StaticThreadStorage;

  static CMTK_THREAD_RETURN_TYPE EvaluateLocalGradientThreadFunc( void* args );

#ifdef CMTK_BUILD_MPI

  typedef enum {
    MESSAGE_TAG_COMPUTE = 1,
    MESSAGE_TAG_RESULTS = 2,
    MESSAGE_TAG_FINISHED = 3
  } MessageTagMPI;

  ThreadSemaphore m_ThreadWorkSemaphore;

  ThreadSemaphore m_ThreadReadySemaphore;

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


} // namespace cmtk

#endif // #ifndef __cmtkSplineWarpCongealingFunctional_h_included_