1 /*=========================================================================
2 Program: vv http://www.creatis.insa-lyon.fr/rio/vv
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
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.
13 It is distributed under dual licence
15 - BSD See included LICENSE.txt file
16 - CeCILL-B http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
17 ===========================================================================**/
19 /*=========================================================================
21 Program: Insight Segmentation & Registration Toolkit
22 Module: $RCSfile: itkOptMeanSquaresImageToImageMetricFor3DBLUTFFD.h,v $
24 Date: $Date: 2010/06/14 17:32:07 $
25 Version: $Revision: 1.1 $
27 Copyright (c) Insight Software Consortium. All rights reserved.
28 See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
30 This software is distributed WITHOUT ANY WARRANTY; without even
31 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
32 PURPOSE. See the above copyright notices for more information.
34 =========================================================================*/
35 #ifndef __itkOptMeanSquaresImageToImageMetricFor3DBLUTFFD_h
36 #define __itkOptMeanSquaresImageToImageMetricFor3DBLUTFFD_h
38 #include "itkImageToImageMetric.h"
39 #include "itkCovariantVector.h"
46 template <class TFixedImage,class TMovingImage >
47 class ITK_EXPORT MeanSquaresImageToImageMetricFor3DBLUTFFD :
48 public ImageToImageMetric< TFixedImage, TMovingImage >
52 /** Standard class typedefs. */
53 typedef MeanSquaresImageToImageMetricFor3DBLUTFFD Self;
54 typedef ImageToImageMetric< TFixedImage, TMovingImage > Superclass;
55 typedef SmartPointer<Self> Pointer;
56 typedef SmartPointer<const Self> ConstPointer;
58 /** Method for creation through the object factory. */
61 /** Run-time type information (and related methods). */
62 itkTypeMacro(MeanSquaresImageToImageMetricFor3DBLUTFFD, ImageToImageMetric);
64 /** Types inherited from Superclass. */
65 typedef typename Superclass::TransformType TransformType;
66 typedef typename Superclass::TransformPointer TransformPointer;
67 typedef typename Superclass::TransformJacobianType TransformJacobianType;
68 typedef typename Superclass::InterpolatorType InterpolatorType;
69 typedef typename Superclass::MeasureType MeasureType;
70 typedef typename Superclass::DerivativeType DerivativeType;
71 typedef typename Superclass::ParametersType ParametersType;
72 typedef typename Superclass::FixedImageType FixedImageType;
73 typedef typename Superclass::MovingImageType MovingImageType;
74 typedef typename Superclass::MovingImagePointType MovingImagePointType;
75 typedef typename Superclass::FixedImageConstPointer FixedImageConstPointer;
76 typedef typename Superclass::MovingImageConstPointer MovingImageConstPointer;
77 typedef typename Superclass::CoordinateRepresentationType
78 CoordinateRepresentationType;
79 typedef typename Superclass::FixedImageSampleContainer
80 FixedImageSampleContainer;
81 typedef typename Superclass::ImageDerivativesType ImageDerivativesType;
82 typedef typename Superclass::WeightsValueType WeightsValueType;
83 typedef typename Superclass::IndexValueType IndexValueType;
85 // Needed for evaluation of Jacobian.
86 typedef typename Superclass::FixedImagePointType FixedImagePointType;
88 /** The moving image dimension. */
89 itkStaticConstMacro( MovingImageDimension, unsigned int,
90 MovingImageType::ImageDimension );
93 * Initialize the Metric by
94 * (1) making sure that all the components are present and plugged
96 * (2) uniformly select NumberOfSpatialSamples within
97 * the FixedImageRegion, and
98 * (3) allocate memory for pdf data structures. */
99 #if ( ( ITK_VERSION_MAJOR == 4 ) && ( ITK_VERSION_MINOR > 12 ) || ( ITK_VERSION_MAJOR > 4 ))
100 virtual void Initialize(void) ITK_OVERRIDE;
102 virtual void Initialize(void) throw ( ExceptionObject ) ITK_OVERRIDE;
105 /** Get the value. */
106 MeasureType GetValue( const ParametersType & parameters ) const ITK_OVERRIDE;
108 /** Get the derivatives of the match measure. */
109 void GetDerivative( const ParametersType & parameters,
110 DerivativeType & Derivative ) const ITK_OVERRIDE;
112 /** Get the value and derivatives for single valued optimizers. */
113 void GetValueAndDerivative( const ParametersType & parameters,
115 DerivativeType & Derivative ) const ITK_OVERRIDE;
119 MeanSquaresImageToImageMetricFor3DBLUTFFD();
120 virtual ~MeanSquaresImageToImageMetricFor3DBLUTFFD();
121 void PrintSelf(std::ostream& os, Indent indent) const ITK_OVERRIDE;
125 //purposely not implemented
126 MeanSquaresImageToImageMetricFor3DBLUTFFD(const Self &);
127 //purposely not implemented
128 void operator=(const Self &);
130 inline bool GetValueThreadProcessSample( unsigned int threadID,
131 unsigned long fixedImageSample,
132 const MovingImagePointType & mappedPoint,
133 double movingImageValue ) const ITK_OVERRIDE;
135 inline bool GetValueAndDerivativeThreadProcessSample( unsigned int threadID,
136 unsigned long fixedImageSample,
137 const MovingImagePointType & mappedPoint,
138 double movingImageValue,
139 const ImageDerivativesType &
140 movingImageGradientValue ) const ITK_OVERRIDE;
142 MeasureType * m_ThreaderMSE;
143 DerivativeType * m_ThreaderMSEDerivatives;
147 } // end namespace itk
149 #ifndef ITK_MANUAL_INSTANTIATION
150 #include "itkOptMeanSquaresImageToImageMetricFor3DBLUTFFD.txx"