ITK  5.4.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  * https://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_MOVE(NormalizedCorrelationPointSetToImageMetric);
49 
55 
57  itkNewMacro(Self);
58 
60  itkOverrideGetNameOfClassMacro(NormalizedCorrelationPointSetToImageMetric);
61 
63  using typename Superclass::RealType;
64  using typename Superclass::TransformType;
65  using typename Superclass::TransformPointer;
66  using typename Superclass::TransformParametersType;
67  using typename Superclass::TransformJacobianType;
68  using typename Superclass::GradientPixelType;
69 
70  using typename Superclass::MeasureType;
71  using typename Superclass::DerivativeType;
72  using typename Superclass::FixedPointSetType;
73  using typename Superclass::MovingImageType;
74  using typename Superclass::FixedPointSetConstPointer;
75  using typename Superclass::MovingImageConstPointer;
76 
77  using typename Superclass::PointIterator;
78  using typename Superclass::PointDataIterator;
79  using typename Superclass::InputPointType;
80  using 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);
105 protected:
107  ~NormalizedCorrelationPointSetToImageMetric() override = default;
108  void
109  PrintSelf(std::ostream & os, Indent indent) const override;
110 
111 private:
112  bool m_SubtractMean{};
113 };
114 } // end namespace itk
115 
116 #ifndef ITK_MANUAL_INSTANTIATION
117 # include "itkNormalizedCorrelationPointSetToImageMetric.hxx"
118 #endif
119 
120 #endif
itk::SingleValuedCostFunction::MeasureType
double MeasureType
Definition: itkSingleValuedCostFunction.h:50
itkCovariantVector.h
itkPoint.h
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::NormalizedCorrelationPointSetToImageMetric
Computes similarity between pixel values of a point set and intensity values of an image.
Definition: itkNormalizedCorrelationPointSetToImageMetric.h:44
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:55
itk::PointSetToImageMetric
Computes similarity between a point set and an image.
Definition: itkPointSetToImageMetric.h:48
itkPointSetToImageMetric.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Array
Array class with size defined at construction time.
Definition: itkArray.h:47
itk::PointSetToImageMetric::TransformParametersType
typename TransformType::ParametersType TransformParametersType
Definition: itkPointSetToImageMetric.h:88