registration/clitkOptNormalizedCorrelationImageToImageMetric.txx

   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_txx
  20 #define __clitkOptNormalizedCorrelationImageToImageMetric_txx
  21
  22 #include "clitkOptNormalizedCorrelationImageToImageMetric.h"
  23 #include "itkCovariantVector.h"
  24 #include "itkImageRandomConstIteratorWithIndex.h"
  25 #include "itkImageRegionConstIterator.h"
  26 #include "itkImageRegionIterator.h"
  27 #include "itkImageIterator.h"
  28 #include "vnl/vnl_math.h"
  29
  30 namespace clitk
  31 {
  32
  33 /**
  34  * Constructor
  35  */
  36 template < class TFixedImage, class TMovingImage >
  37 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
  38 ::NormalizedCorrelationImageToImageMetric()
  39 {
  40   this->SetComputeGradient(true);
  41
  42   m_ThreaderSFF = NULL;
  43   m_ThreaderSMM = NULL;
  44   m_ThreaderSFM = NULL;
  45   m_ThreaderSF = NULL;
  46   m_ThreaderSM = NULL;
  47   m_ThreaderDerivativeF = NULL;
  48   m_ThreaderDerivativeM = NULL;
  49   this->m_WithinThreadPreProcess = false;
  50   this->m_WithinThreadPostProcess = false;
  51
  52   //  For backward compatibility, the default behavior is to use all the pixels
  53   //  in the fixed image.
  54   this->UseAllPixelsOn();
  55
  56   m_SubtractMean=false;
  57
  58 }
  59
  60 template < class TFixedImage, class TMovingImage >
  61 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
  62 ::~NormalizedCorrelationImageToImageMetric()
  63 {
  64   if(m_ThreaderSFF != NULL) {
  65     delete [] m_ThreaderSFF;
  66   }
  67   m_ThreaderSFF = NULL;
  68
  69   if(m_ThreaderSMM != NULL) {
  70     delete [] m_ThreaderSMM;
  71   }
  72   m_ThreaderSMM = NULL;
  73
  74   if(m_ThreaderSFM != NULL) {
  75     delete [] m_ThreaderSFM;
  76   }
  77   m_ThreaderSFM = NULL;
  78
  79   if(m_ThreaderSF != NULL) {
  80     delete [] m_ThreaderSF;
  81   }
  82   m_ThreaderSF = NULL;
  83
  84   if(m_ThreaderSM != NULL) {
  85     delete [] m_ThreaderSM;
  86   }
  87   m_ThreaderSM = NULL;
  88
  89   if(m_ThreaderDerivativeF != NULL) {
  90     delete [] m_ThreaderDerivativeF;
  91   }
  92   m_ThreaderDerivativeF = NULL;
  93
  94   if(m_ThreaderDerivativeM != NULL) {
  95     delete [] m_ThreaderDerivativeM;
  96   }
  97   m_ThreaderDerivativeM = NULL;
  98 }
  99
 100 /**
 101  * Print out internal information about this class
 102  */
 103 template < class TFixedImage, class TMovingImage  >
 104 void
 105 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 106 ::PrintSelf(std::ostream& os, itk::Indent indent) const
 107 {
 108
 109   Superclass::PrintSelf(os, indent);
 110
 111 }
 112
 113
 114 /**
 115  * Initialize
 116  */
 117 template <class TFixedImage, class TMovingImage>
 118 void
 119 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 120 ::Initialize(void) throw ( itk::ExceptionObject )
 121 {
 122
 123   this->Superclass::Initialize();
 124   this->Superclass::MultiThreadingInitialize();
 125
 126
 127   /**
 128    * Allocate memory for the accumulators (set to zero in GetValue)
 129    */
 130   if(m_ThreaderSFF != NULL) {
 131     delete [] m_ThreaderSFF;
 132   }
 133   m_ThreaderSFF = new double[this->m_NumberOfThreads];
 134
 135
 136   if(m_ThreaderSMM != NULL) {
 137     delete [] m_ThreaderSMM;
 138   }
 139   m_ThreaderSMM = new double[this->m_NumberOfThreads];
 140
 141   if(m_ThreaderSFM != NULL) {
 142     delete [] m_ThreaderSFM;
 143   }
 144   m_ThreaderSFM = new double[this->m_NumberOfThreads];
 145
 146   if(this->m_SubtractMean) {
 147     if(m_ThreaderSF != NULL) {
 148       delete [] m_ThreaderSF;
 149     }
 150     m_ThreaderSF = new double[this->m_NumberOfThreads];
 151
 152     if(m_ThreaderSM != NULL) {
 153       delete [] m_ThreaderSM;
 154     }
 155     m_ThreaderSM = new double[this->m_NumberOfThreads];
 156   }
 157
 158   if(m_ThreaderDerivativeF != NULL) {
 159     delete [] m_ThreaderDerivativeF;
 160   }
 161   m_ThreaderDerivativeF = new DerivativeType[this->m_NumberOfThreads];
 162   for(unsigned int threadID=0; threadID<this->m_NumberOfThreads; threadID++) {
 163     m_ThreaderDerivativeF[threadID].SetSize( this->m_NumberOfParameters );
 164   }
 165
 166   if(m_ThreaderDerivativeM != NULL) {
 167     delete [] m_ThreaderDerivativeM;
 168   }
 169   m_ThreaderDerivativeM = new DerivativeType[this->m_NumberOfThreads];
 170   for(unsigned int threadID=0; threadID<this->m_NumberOfThreads; threadID++) {
 171     m_ThreaderDerivativeM[threadID].SetSize( this->m_NumberOfParameters );
 172   }
 173 }
 174
 175
 176 template < class TFixedImage, class TMovingImage  >
 177 inline bool
 178 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 179 ::GetValueThreadProcessSample(
 180   unsigned int threadID,
 181   unsigned long fixedImageSample,
 182   const MovingImagePointType & itkNotUsed(mappedPoint),
 183   double movingImageValue) const
 184 {
 185   const RealType fixedImageValue= this->m_FixedImageSamples[fixedImageSample].value;
 186   m_ThreaderSFF[threadID] += fixedImageValue  * fixedImageValue;
 187   m_ThreaderSMM[threadID] += movingImageValue * movingImageValue;
 188   m_ThreaderSFM[threadID] += fixedImageValue  * movingImageValue;
 189   if ( this->m_SubtractMean ) {
 190     m_ThreaderSF[threadID] += fixedImageValue;
 191     m_ThreaderSM[threadID] += movingImageValue;
 192   }
 193
 194   return true;
 195 }
 196
 197 template < class TFixedImage, class TMovingImage  >
 198 typename NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 199 ::MeasureType
 200 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 201 ::GetValue( const ParametersType & parameters ) const
 202 {
 203   itkDebugMacro("GetValue( " << parameters << " ) ");
 204
 205   if( !this->m_FixedImage ) {
 206     itkExceptionMacro( << "Fixed image has not been assigned" );
 207   }
 208
 209
 210   //Reset the accumulators
 211   memset( m_ThreaderSFF,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 212   memset( m_ThreaderSMM,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 213   memset( m_ThreaderSFM,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 214   if(this->m_SubtractMean) {
 215     memset( m_ThreaderSF,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 216     memset( m_ThreaderSM,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 217   }
 218
 219
 220   // Set up the parameters in the transform
 221   this->m_Transform->SetParameters( parameters );
 222
 223   // MUST BE CALLED TO INITIATE PROCESSING
 224   this->GetValueMultiThreadedInitiate();
 225
 226   itkDebugMacro( "Ratio of voxels mapping into moving image buffer: "
 227                  << this->m_NumberOfPixelsCounted << " / "
 228                  << this->m_NumberOfFixedImageSamples
 229                  << std::endl );
 230
 231   if( this->m_NumberOfPixelsCounted <
 232       this->m_NumberOfFixedImageSamples / 4 ) {
 233     itkExceptionMacro( "Too many samples map outside moving image buffer: "
 234                        << this->m_NumberOfPixelsCounted << " / "
 235                        << this->m_NumberOfFixedImageSamples
 236                        << std::endl );
 237   }
 238
 239   // Accumulate the threads
 240   AccumulateType sff, smm, sfm, sf, sm;
 241   sff = m_ThreaderSFF[0];
 242   smm = m_ThreaderSMM[0];
 243   sfm = m_ThreaderSFM[0];
 244   sf  = m_ThreaderSF[0];
 245   sm  = m_ThreaderSM[0];
 246
 247   for(unsigned int t=1; t<this->m_NumberOfThreads; t++) {
 248     sff +=  m_ThreaderSFF[t];
 249     smm +=  m_ThreaderSMM[t];
 250     sfm +=  m_ThreaderSFM[t];
 251     if ( this->m_SubtractMean ) {
 252       sf +=  m_ThreaderSF[t];
 253       sm +=  m_ThreaderSM[t];
 254     }
 255   }
 256
 257   if ( this->m_SubtractMean && this->m_NumberOfPixelsCounted > 0 ) {
 258     sff -= ( sf * sf / this->m_NumberOfPixelsCounted );
 259     smm -= ( sm * sm / this->m_NumberOfPixelsCounted );
 260     sfm -= ( sf * sm / this->m_NumberOfPixelsCounted );
 261   }
 262
 263
 264   const RealType denom = -1.0 * vcl_sqrt(sff * smm );
 265   MeasureType measure;
 266   if( this->m_NumberOfPixelsCounted > 0 && denom != 0.0) {
 267     measure = sfm / denom;
 268   } else {
 269     measure = itk::NumericTraits< MeasureType >::Zero;
 270   }
 271
 272
 273   return measure;
 274 }
 275
 276
 277 template < class TFixedImage, class TMovingImage  >
 278 typename NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 279 ::MeasureType
 280 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 281 ::ComputeSums( const ParametersType & parameters ) const
 282 {
 283   //No checking for the fixed image,  done in the caller
 284   //Reset the accumulators
 285   memset( m_ThreaderSFF,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 286   memset( m_ThreaderSMM,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 287   memset( m_ThreaderSFM,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 288   if(this->m_SubtractMean) {
 289     memset( m_ThreaderSF,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 290     memset( m_ThreaderSM,  0,  this->m_NumberOfThreads * sizeof(AccumulateType) );
 291   }
 292
 293
 294   // Set up the parameters in the transform
 295   this->m_Transform->SetParameters( parameters );
 296
 297   // MUST BE CALLED TO INITIATE PROCESSING
 298   this->GetValueMultiThreadedInitiate();
 299
 300   itkDebugMacro( "Ratio of voxels mapping into moving image buffer: "
 301                  << this->m_NumberOfPixelsCounted << " / "
 302                  << this->m_NumberOfFixedImageSamples
 303                  << std::endl );
 304
 305   if( this->m_NumberOfPixelsCounted <
 306       this->m_NumberOfFixedImageSamples / 4 ) {
 307     itkExceptionMacro( "Too many samples map outside moving image buffer: "
 308                        << this->m_NumberOfPixelsCounted << " / "
 309                        << this->m_NumberOfFixedImageSamples
 310                        << std::endl );
 311   }
 312
 313   // Accumulate the threads
 314   m_SFF = m_ThreaderSFF[0];
 315   m_SMM = m_ThreaderSMM[0];
 316   m_SFM = m_ThreaderSFM[0];
 317   m_SF  = m_ThreaderSF[0];
 318   m_SM  = m_ThreaderSM[0];
 319
 320   for(unsigned int t=1; t<this->m_NumberOfThreads; t++) {
 321     m_SFF +=  m_ThreaderSFF[t];
 322     m_SMM +=  m_ThreaderSMM[t];
 323     m_SFM +=  m_ThreaderSFM[t];
 324     if ( this->m_SubtractMean ) {
 325       m_SF +=  m_ThreaderSF[t];
 326       m_SM +=  m_ThreaderSM[t];
 327     }
 328   }
 329
 330   if ( this->m_SubtractMean && this->m_NumberOfPixelsCounted > 0 ) {
 331     m_SFF -= ( m_SF * m_SF / this->m_NumberOfPixelsCounted );
 332     m_SMM -= ( m_SM * m_SM / this->m_NumberOfPixelsCounted );
 333     m_SFM -= ( m_SF * m_SM / this->m_NumberOfPixelsCounted );
 334     m_FixedMean=m_SF / this->m_NumberOfPixelsCounted;
 335     m_MovingMean=m_SM / this->m_NumberOfPixelsCounted;
 336   }
 337
 338
 339   m_Denom = -1.0 * vcl_sqrt(m_SFF * m_SMM );
 340   MeasureType measure;
 341   if( this->m_NumberOfPixelsCounted > 0 && m_Denom != 0.0) {
 342     measure = m_SFM / m_Denom;
 343   } else {
 344     measure = itk::NumericTraits< MeasureType >::Zero;
 345   }
 346
 347   return measure;
 348 }
 349
 350
 351 template < class TFixedImage, class TMovingImage  >
 352 inline bool
 353 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 354 ::GetValueAndDerivativeThreadProcessSample(
 355   unsigned int threadID,
 356   unsigned long fixedImageSample,
 357   const MovingImagePointType & itkNotUsed(mappedPoint),
 358   double movingImageValue,
 359   const ImageDerivativesType &
 360   movingImageGradientValue
 361 ) const
 362 {
 363
 364   const RealType fixedImageValue=this->m_FixedImageSamples[fixedImageSample].value;
 365   const FixedImagePointType fixedImagePoint = this->m_FixedImageSamples[fixedImageSample].point;
 366
 367   // Need to use one of the threader transforms if we're
 368   // not in thread 0.
 369   //
 370   // Use a raw pointer here to avoid the overhead of smart pointers.
 371   // For instance, Register and UnRegister have mutex locks around
 372   // the reference counts.
 373   TransformType* transform;
 374
 375   if (threadID > 0) {
 376     transform = this->m_ThreaderTransform[threadID - 1];
 377   } else {
 378     transform = this->m_Transform;
 379   }
 380
 381   // Jacobian should be evaluated at the unmapped (fixed image) point.
 382   TransformJacobianType jacobian;
 383   transform->ComputeJacobianWithRespectToParameters(fixedImagePoint, jacobian);
 384
 385   for(unsigned int par=0; par<this->m_NumberOfParameters; par++) {
 386     RealType sumF = itk::NumericTraits< RealType >::Zero;
 387     RealType sumM = itk::NumericTraits< RealType >::Zero;
 388     for(unsigned int dim=0; dim<MovingImageDimension; dim++) {
 389       const RealType differential = jacobian( dim, par ) * movingImageGradientValue[dim];
 390       if ( this->m_SubtractMean && this->m_NumberOfPixelsCounted > 0 ) {
 391         sumF += (fixedImageValue-m_FixedMean)  * differential;
 392         sumM += (movingImageValue-m_MovingMean) * differential;
 393       } else {
 394         sumF += differential * fixedImageValue;
 395         sumM += differential * movingImageValue;
 396       }
 397     }
 398     m_ThreaderDerivativeF[threadID][par] += sumF;
 399     m_ThreaderDerivativeM[threadID][par] += sumM;
 400   }
 401
 402   return true;
 403 }
 404
 405
 406 /**
 407  * Get the both Value and Derivative Measure
 408  */
 409 template < class TFixedImage, class TMovingImage  >
 410 void
 411 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 412 ::GetValueAndDerivative( const ParametersType & parameters,
 413                          MeasureType & value,
 414                          DerivativeType & derivative) const
 415 {
 416
 417   if( !this->m_FixedImage ) {
 418     itkExceptionMacro( << "Fixed image has not been assigned" );
 419   }
 420
 421   // Set up the parameters in the transform
 422   this->m_Transform->SetParameters( parameters );
 423
 424   //We need the sums and the value to be calculated first
 425   value=this->ComputeSums(parameters);
 426
 427   //Set output values to zero
 428   if(derivative.GetSize() != this->m_NumberOfParameters) {
 429     derivative = DerivativeType( this->m_NumberOfParameters );
 430   }
 431   memset( derivative.data_block(),
 432           0,
 433           this->m_NumberOfParameters * sizeof(typename DerivativeType::ValueType) );
 434
 435   for( unsigned int threadID = 0; threadID<this->m_NumberOfThreads; threadID++ ) {
 436     memset( m_ThreaderDerivativeF[threadID].data_block(),
 437             0,
 438             this->m_NumberOfParameters * sizeof(typename DerivativeType::ValueType) );
 439
 440     memset( m_ThreaderDerivativeM[threadID].data_block(),
 441             0,
 442             this->m_NumberOfParameters * sizeof(typename DerivativeType::ValueType) );
 443   }
 444
 445   // MUST BE CALLED TO INITIATE PROCESSING
 446   this->GetValueAndDerivativeMultiThreadedInitiate();
 447
 448   // Accumulate over the threads
 449   DerivativeType derivativeF(this->m_NumberOfParameters), derivativeM(this->m_NumberOfParameters);
 450   for(unsigned int t=0; t<this->m_NumberOfThreads; t++) {
 451     for(unsigned int parameter = 0; parameter < this->m_NumberOfParameters; parameter++) {
 452       derivativeF[parameter] += m_ThreaderDerivativeF[t][parameter];
 453       derivativeM[parameter] += m_ThreaderDerivativeM[t][parameter];
 454     }
 455   }
 456
 457   //Compute derivatives
 458   if( this->m_NumberOfPixelsCounted > 0 && m_Denom != 0.0) {
 459     for(unsigned int i=0; i<this->m_NumberOfParameters; i++) {
 460       derivative[i] = ( derivativeF[i] - (m_SFM/m_SMM)* derivativeM[i] ) / m_Denom;
 461     }
 462   } else {
 463     for(unsigned int i=0; i<this->m_NumberOfParameters; i++) {
 464       derivative[i] = itk::NumericTraits< MeasureType >::Zero;
 465     }
 466   }
 467
 468 }
 469
 470
 471 /**
 472  * Get the match measure derivative
 473  */
 474 template < class TFixedImage, class TMovingImage  >
 475 void
 476 NormalizedCorrelationImageToImageMetric<TFixedImage,TMovingImage>
 477 ::GetDerivative( const ParametersType & parameters,
 478                  DerivativeType & derivative ) const
 479 {
 480   if( !this->m_FixedImage ) {
 481     itkExceptionMacro( << "Fixed image has not been assigned" );
 482   }
 483
 484   MeasureType value;
 485   // call the combined version
 486   this->GetValueAndDerivative( parameters, value, derivative );
 487 }
 488
 489 } // end namespace clitk
 490
 491
 492 #endif