registration/clitkOptNormalizedCorrelationImageToImageMetric.h

   1 /*=========================================================================
   2   Program:   vv                     http://www.creatis.insa-lyon.fr/rio/vv
   3
   4   Authors belong to:
   5   - University of LYON              http://www.universite-lyon.fr/
   6   - Léon Bérard cancer center       http://www.centreleonberard.fr
   7   - CREATIS CNRS laboratory         http://www.creatis.insa-lyon.fr
   8
   9   This software is distributed WITHOUT ANY WARRANTY; without even
  10   the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  11   PURPOSE.  See the copyright notices for more information.
  12
  13   It is distributed under dual licence
  14
  15   - BSD        See included LICENSE.txt file
  16   - CeCILL-B   http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  17 ===========================================================================**/
  18
  19 #ifndef __clitkOptNormalizedCorrelationImageToImageMetric_h
  20 #define __clitkOptNormalizedCorrelationImageToImageMetric_h
  21
  22 #include "itkImageToImageMetric.h"
  23 #include "itkCovariantVector.h"
  24 #include "itkPoint.h"
  25 #include "itkIndex.h"
  26
  27 #include "itkMultiThreader.h"
  28
  29 namespace clitk
  30 {
  31
  32 template <class TFixedImage,class TMovingImage >
  33 class ITK_EXPORT NormalizedCorrelationImageToImageMetric :
  34   public itk::ImageToImageMetric< TFixedImage, TMovingImage >
  35 {
  36 public:
  37
  38   /** Standard class typedefs. */
  39   typedef NormalizedCorrelationImageToImageMetric                     Self;
  40   typedef itk::ImageToImageMetric< TFixedImage, TMovingImage >   Superclass;
  41   typedef itk::SmartPointer<Self>                                Pointer;
  42   typedef itk::SmartPointer<const Self>                          ConstPointer;
  43
  44   /** Method for creation through the object factory. */
  45   itkNewMacro(Self);
  46
  47   /** Run-time type information (and related methods). */
  48   itkTypeMacro(NormalizedCorrelationImageToImageMetric, ImageToImageMetric);
  49
  50   /** Types inherited from Superclass. */
  51   typedef typename Superclass::RealType                 RealType;
  52   typedef typename Superclass::TransformType            TransformType;
  53   typedef typename Superclass::TransformPointer         TransformPointer;
  54   typedef typename Superclass::TransformJacobianType    TransformJacobianType;
  55   typedef typename Superclass::InterpolatorType         InterpolatorType;
  56   typedef typename Superclass::MeasureType              MeasureType;
  57   typedef typename Superclass::DerivativeType           DerivativeType;
  58   typedef typename Superclass::ParametersType           ParametersType;
  59   typedef typename Superclass::FixedImageType           FixedImageType;
  60   typedef typename Superclass::MovingImageType          MovingImageType;
  61   typedef typename Superclass::MovingImagePointType     MovingImagePointType;
  62   typedef typename Superclass::FixedImageConstPointer   FixedImageConstPointer;
  63   typedef typename Superclass::MovingImageConstPointer  MovingImageConstPointer;
  64   typedef typename Superclass::CoordinateRepresentationType
  65   CoordinateRepresentationType;
  66   typedef typename Superclass::FixedImageSampleContainer
  67   FixedImageSampleContainer;
  68   typedef typename Superclass::ImageDerivativesType     ImageDerivativesType;
  69   typedef typename Superclass::WeightsValueType         WeightsValueType;
  70   typedef typename Superclass::IndexValueType           IndexValueType;
  71
  72   // Needed for evaluation of Jacobian.
  73   typedef typename Superclass::FixedImagePointType     FixedImagePointType;
  74
  75   //Accumulators
  76   typedef  typename itk::NumericTraits< MeasureType >::AccumulateType AccumulateType;
  77
  78   /** The moving image dimension. */
  79   itkStaticConstMacro( MovingImageDimension, unsigned int,
  80                        MovingImageType::ImageDimension );
  81
  82
  83   /** Set/Get SubtractMean boolean. If true, the sample mean is subtracted
  84    * from the sample values in the cross-correlation formula and
  85    * typically results in narrower valleys in the cost fucntion.
  86    * Default value is false. */
  87   itkSetMacro( SubtractMean, bool );
  88   itkGetConstReferenceMacro( SubtractMean, bool );
  89   itkBooleanMacro( SubtractMean );
  90
  91   /**
  92    *  Initialize the Metric by
  93    *  (1) making sure that all the components are present and plugged
  94    *      together correctly,
  95    *  (2) uniformly select NumberOfSpatialSamples within
  96    *      the FixedImageRegion, and
  97    *  (3) allocate memory for pdf data structures. */
  98 #if ( ( ITK_VERSION_MAJOR == 4 ) && ( ITK_VERSION_MINOR > 12 ) || ( ITK_VERSION_MAJOR > 4 ))
  99   virtual void Initialize(void) ITK_OVERRIDE;
 100 #else
 101   virtual void Initialize(void) throw ( itk::ExceptionObject ) ITK_OVERRIDE;
 102 #endif
 103
 104   /**  Get the value. */
 105   MeasureType GetValue( const ParametersType & parameters ) const ITK_OVERRIDE;
 106
 107   /** Get the derivatives of the match measure. */
 108   void GetDerivative( const ParametersType & parameters,
 109                       DerivativeType & Derivative ) const ITK_OVERRIDE;
 110
 111   /**  Get the value and derivatives for single valued optimizers. */
 112   void GetValueAndDerivative( const ParametersType & parameters,
 113                               MeasureType & Value,
 114                               DerivativeType & Derivative ) const ITK_OVERRIDE;
 115
 116 protected:
 117
 118   NormalizedCorrelationImageToImageMetric();
 119   virtual ~NormalizedCorrelationImageToImageMetric();
 120   void PrintSelf(std::ostream& os, itk::Indent indent) const ITK_OVERRIDE;
 121
 122 private:
 123
 124   //purposely not implemented
 125   NormalizedCorrelationImageToImageMetric(const Self &);
 126   //purposely not implemented
 127   void operator=(const Self &);
 128
 129   /**  Get the value for the derivative computation. */
 130   MeasureType ComputeSums( const ParametersType & parameters ) const;
 131
 132
 133   inline bool GetValueThreadProcessSample( unsigned int threadID,
 134       unsigned long fixedImageSample,
 135       const MovingImagePointType & mappedPoint,
 136       double movingImageValue ) const ITK_OVERRIDE;
 137
 138
 139   inline bool GetValueAndDerivativeThreadProcessSample( unsigned int threadID,
 140       unsigned long fixedImageSample,
 141       const MovingImagePointType & mappedPoint,
 142       double movingImageValue,
 143       const ImageDerivativesType &
 144       movingImageGradientValue ) const ITK_OVERRIDE;
 145
 146   AccumulateType *m_ThreaderSFF, *m_ThreaderSMM, *m_ThreaderSFM, *m_ThreaderSF, *m_ThreaderSM;
 147   mutable AccumulateType m_SFF, m_SMM, m_SFM, m_SF, m_SM;
 148   mutable RealType m_Denom, m_FixedMean, m_MovingMean;
 149   DerivativeType * m_ThreaderDerivativeF, *m_ThreaderDerivativeM;
 150
 151
 152   bool m_SubtractMean;
 153 };
 154
 155 } // end namespace clitk
 156
 157 #ifndef ITK_MANUAL_INSTANTIATION
 158 #include "clitkOptNormalizedCorrelationImageToImageMetric.txx"
 159 #endif
 160
 161 #endif
 162
 163