File: elxMultiResolutionRegistrationWithFeatures.h

package info (click to toggle)
elastix 5.2.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 42,480 kB
  • sloc: cpp: 68,403; lisp: 4,118; python: 1,013; xml: 182; sh: 177; makefile: 33
file content (201 lines) | stat: -rw-r--r-- 7,519 bytes parent folder | download
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*=========================================================================
 *
 *  Copyright UMC Utrecht and contributors
 *
 *  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
 *
 *        http://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 elxMultiResolutionRegistrationWithFeatures_h
#define elxMultiResolutionRegistrationWithFeatures_h

#include "elxIncludes.h" // include first to avoid MSVS warning
#include "itkMultiResolutionImageRegistrationMethodWithFeatures.h"

namespace elastix
{

/**
 * \class MultiResolutionRegistrationWithFeatures
 * \brief A registration framework based on the
 *   itk::MultiResolutionImageRegistrationMethodWithFeatures.
 *
 * This MultiResolutionRegistrationWithFeatures gives a framework for registration with a
 * multi-resolution approach, using ...
 * Like this for example:\n
 * <tt>(Interpolator "BSplineInterpolator" "BSplineInterpolator")</tt>
 *
 *
 * The parameters used in this class are:\n
 * \parameter Registration: Select this registration framework as follows:\n
 *    <tt>(Registration "MultiResolutionRegistrationWithFeatures")</tt>
 * \parameter NumberOfResolutions: the number of resolutions used. \n
 *    example: <tt>(NumberOfResolutions 4)</tt> \n
 *    The default is 3.\n
 * \parameter Metric\<i\>Weight: The weight for the i-th metric, in each resolution \n
 *    example: <tt>(Metric0Weight 0.5 0.5 0.8)</tt> \n
 *    example: <tt>(Metric1Weight 0.5 0.5 0.2)</tt> \n
 *    The default is 1.0.
 *
 * \ingroup Registrations
 */

template <class TElastix>
class ITK_TEMPLATE_EXPORT MultiResolutionRegistrationWithFeatures
  : public itk::MultiResolutionImageRegistrationMethodWithFeatures<typename RegistrationBase<TElastix>::FixedImageType,
                                                                   typename RegistrationBase<TElastix>::MovingImageType>
  , public RegistrationBase<TElastix>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(MultiResolutionRegistrationWithFeatures);

  /** Standard ITK: Self */
  using Self = MultiResolutionRegistrationWithFeatures;
  using Superclass1 =
    itk::MultiResolutionImageRegistrationMethodWithFeatures<typename RegistrationBase<TElastix>::FixedImageType,
                                                            typename RegistrationBase<TElastix>::MovingImageType>;
  using Superclass2 = RegistrationBase<TElastix>;
  using Pointer = itk::SmartPointer<Self>;
  using ConstPointer = itk::SmartPointer<const Self>;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);

  /** Run-time type information (and related methods). */
  itkTypeMacro(MultiResolutionRegistrationWithFeatures, MultiResolutionImageRegistrationMethodWithFeatures);

  /** Name of this class.
   * Use this name in the parameter file to select this specific registration framework. \n
   * example: <tt>(Registration "MultiResolutionRegistrationWithFeatures")</tt>\n
   */
  elxClassNameMacro("MultiResolutionRegistrationWithFeatures");

  /** Typedef's inherited from Superclass1. */

  /**  Type of the Fixed image. */
  using typename Superclass1::FixedImageType;
  using typename Superclass1::FixedImageConstPointer;
  using typename Superclass1::FixedImageRegionType;

  /**  Type of the Moving image. */
  using typename Superclass1::MovingImageType;
  using typename Superclass1::MovingImageConstPointer;

  /**  Type of the metric. */
  using typename Superclass1::MetricType;
  using typename Superclass1::MetricPointer;

  /**  Type of the Transform . */
  using typename Superclass1::TransformType;
  using typename Superclass1::TransformPointer;

  /**  Type of the Interpolator. */
  using typename Superclass1::InterpolatorType;
  using typename Superclass1::InterpolatorPointer;

  /**  Type of the optimizer. */
  using typename Superclass1::OptimizerType;
  using typename Superclass1::OptimizerPointer;

  /** Type of the Fixed image multiresolution pyramid. */
  using typename Superclass1::FixedImagePyramidType;
  using typename Superclass1::FixedImagePyramidPointer;

  /** Type of the moving image multiresolution pyramid. */
  using typename Superclass1::MovingImagePyramidType;
  using typename Superclass1::MovingImagePyramidPointer;

  /** Type of the Transformation parameters. This is the same type used to
   *  represent the search space of the optimization algorithm.
   */
  using typename Superclass1::ParametersType;

  /** The CombinationMetric type, which is used internally by the Superclass1 */
  // using typename Superclass1::CombinationMetricType;
  // using typename Superclass1::CombinationMetricPointer;

  /** Typedef's from Elastix. */
  using typename Superclass2::ElastixType;
  using RegistrationType = typename Superclass2::RegistrationType;
  using ITKBaseType = typename Superclass2::ITKBaseType;
  using typename Superclass2::UseMaskErosionArrayType;

  /** Get the dimension of the fixed image. */
  itkStaticConstMacro(FixedImageDimension, unsigned int, Superclass2::FixedImageDimension);

  /** Get the dimension of the moving image. */
  itkStaticConstMacro(MovingImageDimension, unsigned int, Superclass2::MovingImageDimension);

  /** Execute stuff before the actual registration:
   * \li Connect all components to the registration framework.
   * \li Set the number of resolution levels.
   * \li Set the fixed image regions.
   * \li Add the sub metric columns to the iteration info object.
   */
  void
  BeforeRegistration() override;

  /** Execute stuff before each resolution:
   * \li Update masks with an erosion.
   * \li Set the metric weights.
   */
  void
  BeforeEachResolution() override;

protected:
  /** The constructor. */
  MultiResolutionRegistrationWithFeatures() = default;

  /** The destructor. */
  ~MultiResolutionRegistrationWithFeatures() override = default;

  /** Typedef's for mask support. */
  using typename Superclass2::MaskPixelType;
  using typename Superclass2::FixedMaskImageType;
  using typename Superclass2::MovingMaskImageType;
  using typename Superclass2::FixedMaskImagePointer;
  using typename Superclass2::MovingMaskImagePointer;
  using typename Superclass2::FixedMaskSpatialObjectType;
  using typename Superclass2::MovingMaskSpatialObjectType;
  using typename Superclass2::FixedMaskSpatialObjectPointer;
  using typename Superclass2::MovingMaskSpatialObjectPointer;

  /** Function to update masks. */
  void
  UpdateFixedMasks(unsigned int level);

  void
  UpdateMovingMasks(unsigned int level);

  /** Read the components from m_Elastix and set them in the Registration class. */
  virtual void
  GetAndSetComponents();

  /** Set the fixed image regions. */
  virtual void
  GetAndSetFixedImageRegions();

  /** Create and set the fixed image interpolators. */
  virtual void
  GetAndSetFixedImageInterpolators();

private:
  elxOverrideGetSelfMacro;
};

} // end namespace elastix

#ifndef ITK_MANUAL_INSTANTIATION
#  include "elxMultiResolutionRegistrationWithFeatures.hxx"
#endif

#endif // end #ifndef elxMultiResolutionRegistrationWithFeatures_h