1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkCompareHistogramImageToImageMetric_h
#define itkCompareHistogramImageToImageMetric_h
#include "itkHistogramImageToImageMetric.h"
namespace itk
{
/** \class CompareHistogramImageToImageMetric
* \brief Compares Histograms between two images to be registered to
* a Training Histogram.
*
* This class is templated over the type of the fixed and moving
* images to be compared.
*
* This metric computes the similarity between the histogram produced
* by two images overlapping and a training histogram.
*
* It is to be sub-classed by the method of comparing the
* histograms.
*
* Generally, the histogram from the training data is to be
* computed in exactly the same way as the histogram from the
* images to be compared are computed. Thus, the user can set the
* interpolator, region, two training images and the transform and
* the training histogram will be formed. OR, the user can simply
* calculate the training histogram separately and set it.
*
* \warning The Initialize function does nothing if the training
* histogram already exists. Thus repeated calls to the Initialize
* function do nothing after the first call. If you wish the
* training histogram to be re-calculated, you should set it to 0.
*
* \author Samson Timoner.
*
* \ingroup RegistrationMetrics
* \ingroup ITKRegistrationCommon
*/
template <typename TFixedImage, typename TMovingImage>
class ITK_TEMPLATE_EXPORT CompareHistogramImageToImageMetric
: public HistogramImageToImageMetric<TFixedImage, TMovingImage>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(CompareHistogramImageToImageMetric);
/** Standard class type aliases. */
using Self = CompareHistogramImageToImageMetric;
using Superclass = HistogramImageToImageMetric<TFixedImage, TMovingImage>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(CompareHistogramImageToImageMetric);
/** Types transferred from the base class */
using typename Superclass::RealType;
using typename Superclass::TransformType;
using typename Superclass::TransformPointer;
using TransformConstPointer = typename TransformType::ConstPointer;
using typename Superclass::TransformParametersType;
using typename Superclass::TransformJacobianType;
using typename Superclass::GradientPixelType;
using typename Superclass::MeasureType;
using typename Superclass::DerivativeType;
using typename Superclass::FixedImageType;
using typename Superclass::MovingImageType;
using typename Superclass::FixedImageConstPointer;
using typename Superclass::MovingImageConstPointer;
using typename Superclass::HistogramType;
using typename Superclass::HistogramSizeType;
using HistogramMeasurementVectorType = typename HistogramType::MeasurementVectorType;
using HistogramAbsoluteFrequencyType = typename HistogramType::AbsoluteFrequencyType;
using HistogramFrequencyType = HistogramAbsoluteFrequencyType;
using HistogramIteratorType = typename HistogramType::Iterator;
using HistogramPointerType = typename HistogramType::Pointer;
using typename Superclass::InterpolatorType;
using typename Superclass::InterpolatorPointer;
using typename Superclass::FixedImageRegionType;
/** Get/Set the histogram to be used in the metric calculation */
itkSetMacro(TrainingHistogram, HistogramPointerType);
itkGetConstReferenceMacro(TrainingHistogram, HistogramPointerType);
/** Get/Set the Training Fixed Image. */
itkSetConstObjectMacro(TrainingFixedImage, FixedImageType);
itkGetConstObjectMacro(TrainingFixedImage, FixedImageType);
/** Get/Set the Training Moving Image. */
itkSetConstObjectMacro(TrainingMovingImage, MovingImageType);
itkGetConstObjectMacro(TrainingMovingImage, MovingImageType);
/** Get/Set the Training Transform. */
itkSetObjectMacro(TrainingTransform, TransformType);
itkGetModifiableObjectMacro(TrainingTransform, TransformType);
/** Get/Set the Interpolator. */
itkSetObjectMacro(TrainingInterpolator, InterpolatorType);
itkGetModifiableObjectMacro(TrainingInterpolator, InterpolatorType);
/** Get/Set the region over which the training histogram will be computed */
itkSetMacro(TrainingFixedImageRegion, FixedImageRegionType);
itkGetConstReferenceMacro(TrainingFixedImageRegion, FixedImageRegionType);
/** Return the number of parameters required by the Transform */
unsigned int
GetNumberOfParameters() const override
{
return this->GetTransform()->GetNumberOfParameters();
}
/** Forms the histogram of the training images to prepare to evaluate the
* metric. Must set all parameters first. */
void
Initialize() override;
protected:
/** Constructor is protected to ensure that \c New() function is used to
create instances. */
CompareHistogramImageToImageMetric();
~CompareHistogramImageToImageMetric() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
/** Form the Histogram for the Training data */
void
FormTrainingHistogram();
/** Evaluates the comparison histogram metric. All sub-classes must
re-implement method. */
MeasureType
EvaluateMeasure(HistogramType & histogram) const override = 0;
private:
FixedImageConstPointer m_TrainingFixedImage{};
MovingImageConstPointer m_TrainingMovingImage{};
TransformPointer m_TrainingTransform{};
InterpolatorPointer m_TrainingInterpolator{};
FixedImageRegionType m_TrainingFixedImageRegion{};
HistogramPointerType m_TrainingHistogram{};
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkCompareHistogramImageToImageMetric.hxx"
#endif
#endif // itkCompareHistogramImageToImageMetric_h
|
