ITK  5.2.0
Insight Toolkit
itkNormalizedCorrelationPointSetToImageMetric.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkNormalizedCorrelationPointSetToImageMetric_h
19 #define itkNormalizedCorrelationPointSetToImageMetric_h
20 
22 #include "itkCovariantVector.h"
23 #include "itkPoint.h"
24 
25 namespace itk
26 {
43 template <typename TFixedPointSet, typename TMovingImage>
45  : public PointSetToImageMetric<TFixedPointSet, TMovingImage>
46 {
47 public:
48  ITK_DISALLOW_COPY_AND_ASSIGN(NormalizedCorrelationPointSetToImageMetric);
49 
55 
57  itkNewMacro(Self);
58 
61 
63  using RealType = typename Superclass::RealType;
64  using TransformType = typename Superclass::TransformType;
65  using TransformPointer = typename Superclass::TransformPointer;
66  using TransformParametersType = typename Superclass::TransformParametersType;
67  using TransformJacobianType = typename Superclass::TransformJacobianType;
68  using GradientPixelType = typename Superclass::GradientPixelType;
69 
70  using MeasureType = typename Superclass::MeasureType;
71  using DerivativeType = typename Superclass::DerivativeType;
72  using FixedPointSetType = typename Superclass::FixedPointSetType;
73  using MovingImageType = typename Superclass::MovingImageType;
74  using FixedPointSetConstPointer = typename Superclass::FixedPointSetConstPointer;
75  using MovingImageConstPointer = typename Superclass::MovingImageConstPointer;
76 
77  using PointIterator = typename Superclass::PointIterator;
78  using PointDataIterator = typename Superclass::PointDataIterator;
79  using InputPointType = typename Superclass::InputPointType;
80  using OutputPointType = typename Superclass::OutputPointType;
81 
83  void
84  GetDerivative(const TransformParametersType & parameters, DerivativeType & Derivative) const override;
85 
88  GetValue(const TransformParametersType & parameters) const override;
89 
91  void
92  GetValueAndDerivative(const TransformParametersType & parameters,
93  MeasureType & Value,
94  DerivativeType & Derivative) const override;
95 
100  itkSetMacro(SubtractMean, bool);
101  itkGetConstReferenceMacro(SubtractMean, bool);
102  itkBooleanMacro(SubtractMean);
104 
105 protected:
107  ~NormalizedCorrelationPointSetToImageMetric() override = default;
108  void
109  PrintSelf(std::ostream & os, Indent indent) const override;
110 
111 private:
113 };
114 } // end namespace itk
115 
116 #ifndef ITK_MANUAL_INSTANTIATION
117 # include "itkNormalizedCorrelationPointSetToImageMetric.hxx"
118 #endif
119 
120 #endif
itk::NormalizedCorrelationPointSetToImageMetric::FixedPointSetType
typename Superclass::FixedPointSetType FixedPointSetType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:72
itk::SingleValuedCostFunction::MeasureType
double MeasureType
Definition: itkSingleValuedCostFunction.h:50
itk::NormalizedCorrelationPointSetToImageMetric::RealType
typename Superclass::RealType RealType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:63
itkCovariantVector.h
itkPoint.h
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::NormalizedCorrelationPointSetToImageMetric::OutputPointType
typename Superclass::OutputPointType OutputPointType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:80
itk::NormalizedCorrelationPointSetToImageMetric
Computes similarity between pixel values of a point set and intensity values of an image.
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:44
itk::NormalizedCorrelationPointSetToImageMetric::m_SubtractMean
bool m_SubtractMean
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:112
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::NormalizedCorrelationPointSetToImageMetric::MovingImageConstPointer
typename Superclass::MovingImageConstPointer MovingImageConstPointer
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:75
itk::PointSetToImageMetric
Computes similarity between a point set and an image.
Definition: itkPointSetToImageMetric.h:48
itk::NormalizedCorrelationPointSetToImageMetric::TransformType
typename Superclass::TransformType TransformType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:64
itk::NormalizedCorrelationPointSetToImageMetric::TransformPointer
typename Superclass::TransformPointer TransformPointer
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:65
itkPointSetToImageMetric.h
itk::NormalizedCorrelationPointSetToImageMetric::PointIterator
typename Superclass::PointIterator PointIterator
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:77
itk::NormalizedCorrelationPointSetToImageMetric::InputPointType
typename Superclass::InputPointType InputPointType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:79
itk::NormalizedCorrelationPointSetToImageMetric::PointDataIterator
typename Superclass::PointDataIterator PointDataIterator
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:78
itk::NormalizedCorrelationPointSetToImageMetric::GradientPixelType
typename Superclass::GradientPixelType GradientPixelType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:68
itk::NormalizedCorrelationPointSetToImageMetric::FixedPointSetConstPointer
typename Superclass::FixedPointSetConstPointer FixedPointSetConstPointer
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:74
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::NormalizedCorrelationPointSetToImageMetric::TransformJacobianType
typename Superclass::TransformJacobianType TransformJacobianType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:67
itk::Array
Array class with size defined at construction time.
Definition: itkArray.h:47
itk::NormalizedCorrelationPointSetToImageMetric::TransformParametersType
typename Superclass::TransformParametersType TransformParametersType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:66
itk::NormalizedCorrelationPointSetToImageMetric::MovingImageType
typename Superclass::MovingImageType MovingImageType
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:73