ITK  5.2.0
Insight Toolkit
itkKullbackLeiblerCompareHistogramImageToImageMetric.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 itkKullbackLeiblerCompareHistogramImageToImageMetric_h
19 #define itkKullbackLeiblerCompareHistogramImageToImageMetric_h
20 
22 
23 namespace itk
24 {
71 template <typename TFixedImage, typename TMovingImage>
73  : public CompareHistogramImageToImageMetric<TFixedImage, TMovingImage>
74 {
75 public:
76  ITK_DISALLOW_COPY_AND_ASSIGN(KullbackLeiblerCompareHistogramImageToImageMetric);
77 
83 
85  itkNewMacro(Self);
86 
89 
91  using RealType = typename Superclass::RealType;
92  using TransformType = typename Superclass::TransformType;
93  using TransformPointer = typename Superclass::TransformPointer;
95  using TransformParametersType = typename Superclass::TransformParametersType;
96  using TransformJacobianType = typename Superclass::TransformJacobianType;
97  using GradientPixelType = typename Superclass::GradientPixelType;
98 
99  using MeasureType = typename Superclass::MeasureType;
100  using DerivativeType = typename Superclass::DerivativeType;
101  using FixedImageType = typename Superclass::FixedImageType;
102  using MovingImageType = typename Superclass::MovingImageType;
103  using FixedImageConstPointer = typename Superclass::FixedImageConstPointer;
104  using MovingImageConstPointer = typename Superclass::MovingImageConstPointer;
105 
106  using HistogramType = typename Superclass::HistogramType;
107  using HistogramSizeType = typename Superclass::HistogramSizeType;
108  using HistogramMeasurementVectorType = typename Superclass::MeasurementVectorType;
109 
110  using HistogramFrequencyType = typename Superclass::HistogramFrequencyType;
111  using HistogramIteratorType = typename Superclass::HistogramIteratorType;
112  using HistogramPointerType = typename Superclass::HistogramPointerType;
113  using InterpolatorType = typename Superclass::InterpolatorType;
114  using InterpolatorPointer = typename Superclass::InterpolatorPointer;
115 
117  itkSetMacro(Epsilon, double);
118 
120  itkGetConstReferenceMacro(Epsilon, double);
121 
123  unsigned int
124  GetNumberOfParameters() const override
125  {
126  return this->GetTransform()->GetNumberOfParameters();
127  }
128 
132  void
133  Initialize() override;
134 
135 protected:
140  void
141  PrintSelf(std::ostream & os, Indent indent) const override;
143 
145  void
146  FormTrainingHistogram();
147 
149  MeasureType
150  EvaluateMeasure(HistogramType & histogram) const override;
151 
152  double m_Epsilon;
153 };
154 } // End namespace itk.
155 
156 #ifndef ITK_MANUAL_INSTANTIATION
157 # include "itkKullbackLeiblerCompareHistogramImageToImageMetric.hxx"
158 #endif
159 
160 #endif // itkKullbackLeiblerCompareHistogramImageToImageMetric_h
itk::CompareHistogramImageToImageMetric::MovingImageType
typename Superclass::MovingImageType MovingImageType
Definition: itkCompareHistogramImageToImageMetric.h:84
itk::SingleValuedCostFunction::MeasureType
double MeasureType
Definition: itkSingleValuedCostFunction.h:50
itk::CompareHistogramImageToImageMetric::HistogramMeasurementVectorType
typename HistogramType::MeasurementVectorType HistogramMeasurementVectorType
Definition: itkCompareHistogramImageToImageMetric.h:90
itk::CompareHistogramImageToImageMetric::FixedImageType
typename Superclass::FixedImageType FixedImageType
Definition: itkCompareHistogramImageToImageMetric.h:83
itk::CompareHistogramImageToImageMetric::TransformConstPointer
typename TransformType::ConstPointer TransformConstPointer
Definition: itkCompareHistogramImageToImageMetric.h:75
itk::CompareHistogramImageToImageMetric::HistogramType
typename Superclass::HistogramType HistogramType
Definition: itkCompareHistogramImageToImageMetric.h:88
itk::CompareHistogramImageToImageMetric::FixedImageConstPointer
typename Superclass::FixedImageConstPointer FixedImageConstPointer
Definition: itkCompareHistogramImageToImageMetric.h:85
itk::CompareHistogramImageToImageMetric::TransformParametersType
typename Superclass::TransformParametersType TransformParametersType
Definition: itkCompareHistogramImageToImageMetric.h:77
itk::KullbackLeiblerCompareHistogramImageToImageMetric
Computes the Kubler Lieblach(KL) metric between the histogram of the two images to be registered and ...
Definition: itkKullbackLeiblerCompareHistogramImageToImageMetric.h:72
itk::CompareHistogramImageToImageMetric::RealType
typename Superclass::RealType RealType
Definition: itkCompareHistogramImageToImageMetric.h:72
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::KullbackLeiblerCompareHistogramImageToImageMetric::GetNumberOfParameters
unsigned int GetNumberOfParameters() const override
Definition: itkKullbackLeiblerCompareHistogramImageToImageMetric.h:124
itk::KullbackLeiblerCompareHistogramImageToImageMetric::m_Epsilon
double m_Epsilon
Definition: itkKullbackLeiblerCompareHistogramImageToImageMetric.h:152
itkCompareHistogramImageToImageMetric.h
itk::CompareHistogramImageToImageMetric::TransformJacobianType
typename Superclass::TransformJacobianType TransformJacobianType
Definition: itkCompareHistogramImageToImageMetric.h:78
itk::CompareHistogramImageToImageMetric::HistogramIteratorType
typename HistogramType::Iterator HistogramIteratorType
Definition: itkCompareHistogramImageToImageMetric.h:94
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::CompareHistogramImageToImageMetric::GradientPixelType
typename Superclass::GradientPixelType GradientPixelType
Definition: itkCompareHistogramImageToImageMetric.h:79
itk::CompareHistogramImageToImageMetric::TransformType
typename Superclass::TransformType TransformType
Definition: itkCompareHistogramImageToImageMetric.h:73
itk::CompareHistogramImageToImageMetric::InterpolatorType
typename Superclass::InterpolatorType InterpolatorType
Definition: itkCompareHistogramImageToImageMetric.h:97
itk::CompareHistogramImageToImageMetric::HistogramFrequencyType
HistogramAbsoluteFrequencyType HistogramFrequencyType
Definition: itkCompareHistogramImageToImageMetric.h:92
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::CompareHistogramImageToImageMetric::InterpolatorPointer
typename Superclass::InterpolatorPointer InterpolatorPointer
Definition: itkCompareHistogramImageToImageMetric.h:98
itk::CompareHistogramImageToImageMetric::HistogramSizeType
typename Superclass::HistogramSizeType HistogramSizeType
Definition: itkCompareHistogramImageToImageMetric.h:89
itk::CompareHistogramImageToImageMetric::TransformPointer
typename Superclass::TransformPointer TransformPointer
Definition: itkCompareHistogramImageToImageMetric.h:74
itk::CompareHistogramImageToImageMetric::HistogramPointerType
typename HistogramType::Pointer HistogramPointerType
Definition: itkCompareHistogramImageToImageMetric.h:95
itk::CompareHistogramImageToImageMetric::MovingImageConstPointer
typename Superclass::MovingImageConstPointer MovingImageConstPointer
Definition: itkCompareHistogramImageToImageMetric.h:86
itk::CompareHistogramImageToImageMetric
Compares Histograms between two images to be registered to a Training Histogram.
Definition: itkCompareHistogramImageToImageMetric.h:56
itk::HistogramImageToImageMetric
Computes similarity between two objects to be registered.
Definition: itkHistogramImageToImageMetric.h:39