ITK  5.4.0
Insight Toolkit
itkPointSetToImageRegistrationMethod.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 itkPointSetToImageRegistrationMethod_h
19 #define itkPointSetToImageRegistrationMethod_h
20 
21 #include "itkProcessObject.h"
22 #include "itkImage.h"
25 #include "itkDataObjectDecorator.h"
26 
27 namespace itk
28 {
66 template <typename TFixedPointSet, typename TMovingImage>
67 class ITK_TEMPLATE_EXPORT PointSetToImageRegistrationMethod : public ProcessObject
68 {
69 public:
70  ITK_DISALLOW_COPY_AND_MOVE(PointSetToImageRegistrationMethod);
71 
77 
79  itkNewMacro(Self);
80 
82  itkOverrideGetNameOfClassMacro(PointSetToImageRegistrationMethod);
83 
85  using FixedPointSetType = TFixedPointSet;
87 
89  using MovingImageType = TMovingImage;
91 
95 
99 
105 
109 
112 
116 
119 
121  itkSetConstObjectMacro(FixedPointSet, FixedPointSetType);
122  itkGetConstObjectMacro(FixedPointSet, FixedPointSetType);
126  itkSetConstObjectMacro(MovingImage, MovingImageType);
127  itkGetConstObjectMacro(MovingImage, MovingImageType);
131  itkSetObjectMacro(Optimizer, OptimizerType);
132  itkGetModifiableObjectMacro(Optimizer, OptimizerType);
136  itkSetObjectMacro(Metric, MetricType);
137  itkGetModifiableObjectMacro(Metric, MetricType);
141  itkSetObjectMacro(Transform, TransformType);
142  itkGetModifiableObjectMacro(Transform, TransformType);
146  itkSetObjectMacro(Interpolator, InterpolatorType);
147  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);
151  virtual void
152  SetInitialTransformParameters(const ParametersType & param);
153 
154  itkGetConstReferenceMacro(InitialTransformParameters, ParametersType);
155 
158  itkGetConstReferenceMacro(LastTransformParameters, ParametersType);
159 
161  void
162  Initialize();
163 
165  const TransformOutputType *
166  GetOutput() const;
167 
171  using Superclass::MakeOutput;
173  MakeOutput(DataObjectPointerArraySizeType output) override;
174 
176  GetMTime() const override;
177 
178 protected:
180  ~PointSetToImageRegistrationMethod() override = default;
181  void
182  PrintSelf(std::ostream & os, Indent indent) const override;
183 
184  void
185  GenerateData() override;
186 
187 private:
188  MetricPointer m_Metric{};
189  OptimizerType::Pointer m_Optimizer{};
190 
191  MovingImageConstPointer m_MovingImage{};
192  FixedPointSetConstPointer m_FixedPointSet{};
193 
194  TransformPointer m_Transform{};
195  InterpolatorPointer m_Interpolator{};
196 
197  ParametersType m_InitialTransformParameters{};
198  ParametersType m_LastTransformParameters{};
199 };
200 } // end namespace itk
201 
202 #ifndef ITK_MANUAL_INSTANTIATION
203 # include "itkPointSetToImageRegistrationMethod.hxx"
204 #endif
205 
206 #endif
Pointer
SmartPointer< Self > Pointer
Definition: itkAddImageFilter.h:93
ConstPointer
SmartPointer< const Self > ConstPointer
Definition: itkAddImageFilter.h:94
itk::SingleValuedNonLinearOptimizer
This class is a base for the Optimization methods that optimize a single valued function.
Definition: itkSingleValuedNonLinearOptimizer.h:35
itk::ModifiedTimeType
SizeValueType ModifiedTimeType
Definition: itkIntTypes.h:105
itk::Optimizer
Generic representation for an optimization method.
Definition: itkOptimizer.h:38
itkImage.h
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ProcessObject::DataObjectPointerArraySizeType
DataObjectPointerArray::size_type DataObjectPointerArraySizeType
Definition: itkProcessObject.h:194
itk::PointSetToImageRegistrationMethod::TransformType
typename MetricType::TransformType TransformType
Definition: itkPointSetToImageRegistrationMethod.h:97
itk::PointSetToImageRegistrationMethod::TransformPointer
typename TransformType::Pointer TransformPointer
Definition: itkPointSetToImageRegistrationMethod.h:98
itk::PointSetToImageRegistrationMethod::MetricPointer
typename MetricType::Pointer MetricPointer
Definition: itkPointSetToImageRegistrationMethod.h:94
itk::DataObjectDecorator
Decorates any subclass of itkObject with a DataObject API.
Definition: itkDataObjectDecorator.h:66
itk::PointSetToImageRegistrationMethod::TransformOutputPointer
typename TransformOutputType::Pointer TransformOutputPointer
Definition: itkPointSetToImageRegistrationMethod.h:103
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:55
itkProcessObject.h
itkDataObjectDecorator.h
itk::PointSetToImageMetric
Computes similarity between a point set and an image.
Definition: itkPointSetToImageMetric.h:48
itk::PointSetToImageRegistrationMethod::FixedPointSetType
TFixedPointSet FixedPointSetType
Definition: itkPointSetToImageRegistrationMethod.h:85
itkPointSetToImageMetric.h
itk::PointSetToImageRegistrationMethod::FixedPointSetConstPointer
typename FixedPointSetType::ConstPointer FixedPointSetConstPointer
Definition: itkPointSetToImageRegistrationMethod.h:86
itk::PointSetToImageRegistrationMethod
Base class for PointSet to Image Registration Methods.
Definition: itkPointSetToImageRegistrationMethod.h:67
itk::PointSetToImageRegistrationMethod::InterpolatorPointer
typename InterpolatorType::Pointer InterpolatorPointer
Definition: itkPointSetToImageRegistrationMethod.h:108
itk::PointSetToImageRegistrationMethod::MovingImageType
TMovingImage MovingImageType
Definition: itkPointSetToImageRegistrationMethod.h:89
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:139
itk::ProcessObject
class ITK_FORWARD_EXPORT ProcessObject
Definition: itkDataObject.h:41
itk::PointSetToImageRegistrationMethod::ParametersType
typename MetricType::TransformParametersType ParametersType
Definition: itkPointSetToImageRegistrationMethod.h:115
itk::Transform
Transform points and vectors from an input space to an output space.
Definition: itkTransform.h:83
itk::PointSetToImageRegistrationMethod::TransformOutputConstPointer
typename TransformOutputType::ConstPointer TransformOutputConstPointer
Definition: itkPointSetToImageRegistrationMethod.h:104
itk::PointSetToImageMetric::TransformParametersType
typename TransformType::ParametersType TransformParametersType
Definition: itkPointSetToImageMetric.h:88
itk::PointSetToImageRegistrationMethod::MovingImageConstPointer
typename MovingImageType::ConstPointer MovingImageConstPointer
Definition: itkPointSetToImageRegistrationMethod.h:90
itkSingleValuedNonLinearOptimizer.h
itk::DataObject::Pointer
SmartPointer< Self > Pointer
Definition: itkDataObject.h:301
itk::PointSetToImageRegistrationMethod::InterpolatorType
typename MetricType::InterpolatorType InterpolatorType
Definition: itkPointSetToImageRegistrationMethod.h:107
itk::InterpolateImageFunction
Base class for all image interpolators.
Definition: itkInterpolateImageFunction.h:45