ITK  5.2.0
Insight Toolkit
itkImageToSpatialObjectRegistrationMethod.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 itkImageToSpatialObjectRegistrationMethod_h
19 #define itkImageToSpatialObjectRegistrationMethod_h
20 
21 #include "itkProcessObject.h"
22 #include "itkImage.h"
25 #include "itkDataObjectDecorator.h"
26 
27 namespace itk
28 {
84 template <typename TFixedImage, typename TMovingSpatialObject>
85 class ITK_TEMPLATE_EXPORT ImageToSpatialObjectRegistrationMethod : public ProcessObject
86 {
87 public:
88  ITK_DISALLOW_COPY_AND_ASSIGN(ImageToSpatialObjectRegistrationMethod);
89 
95 
97  itkNewMacro(Self);
98 
101 
103  using FixedImageType = TFixedImage;
104  using FixedImageConstPointer = typename FixedImageType::ConstPointer;
105 
107  using MovingSpatialObjectType = TMovingSpatialObject;
108  using MovingSpatialObjectConstPointer = typename MovingSpatialObjectType::ConstPointer;
109 
113 
116  using TransformPointer = typename TransformType::Pointer;
117 
123 
126  using InterpolatorPointer = typename InterpolatorType::Pointer;
127 
130 
134 
137 
139  itkSetConstObjectMacro(FixedImage, FixedImageType);
140  itkGetConstObjectMacro(FixedImage, FixedImageType);
142 
144  itkSetConstObjectMacro(MovingSpatialObject, MovingSpatialObjectType);
145  itkGetConstObjectMacro(MovingSpatialObject, MovingSpatialObjectType);
147 
149  itkSetObjectMacro(Optimizer, OptimizerType);
150  itkGetModifiableObjectMacro(Optimizer, OptimizerType);
152 
154  itkSetObjectMacro(Metric, MetricType);
155  itkGetModifiableObjectMacro(Metric, MetricType);
157 
159  itkSetObjectMacro(Transform, TransformType);
160  itkGetModifiableObjectMacro(Transform, TransformType);
162 
164  itkSetObjectMacro(Interpolator, InterpolatorType);
165  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);
167 
169  itkSetMacro(InitialTransformParameters, ParametersType);
170  itkGetConstReferenceMacro(InitialTransformParameters, ParametersType);
172 
175  itkGetConstReferenceMacro(LastTransformParameters, ParametersType);
176 
178  const TransformOutputType *
179  GetOutput() const;
180 
184  using Superclass::MakeOutput;
186  MakeOutput(DataObjectPointerArraySizeType idx) override;
187 
191  GetMTime() const override;
192 
193 protected:
195  ~ImageToSpatialObjectRegistrationMethod() override = default;
196  void
197  PrintSelf(std::ostream & os, Indent indent) const override;
198 
201  void
202  GenerateData() override;
203 
205  void
206  Initialize();
207 
210 
211 private:
214 
217 
220 };
221 } // end namespace itk
222 
223 #ifndef ITK_MANUAL_INSTANTIATION
224 # include "itkImageToSpatialObjectRegistrationMethod.hxx"
225 #endif
226 
227 #endif
itk::ImageToSpatialObjectRegistrationMethod::MovingSpatialObjectConstPointer
typename MovingSpatialObjectType::ConstPointer MovingSpatialObjectConstPointer
Definition: itkImageToSpatialObjectRegistrationMethod.h:108
itk::ImageToSpatialObjectRegistrationMethod
Base class for Image Registration Methods.
Definition: itkImageToSpatialObjectRegistrationMethod.h:85
itkImageToSpatialObjectMetric.h
itk::SingleValuedNonLinearOptimizer
This class is a base for the Optimization methods that optimize a single valued function.
Definition: itkSingleValuedNonLinearOptimizer.h:35
itk::ImageToSpatialObjectRegistrationMethod::MovingSpatialObjectType
TMovingSpatialObject MovingSpatialObjectType
Definition: itkImageToSpatialObjectRegistrationMethod.h:107
itk::ModifiedTimeType
SizeValueType ModifiedTimeType
Definition: itkIntTypes.h:102
itk::ImageToSpatialObjectRegistrationMethod::InterpolatorType
typename MetricType::InterpolatorType InterpolatorType
Definition: itkImageToSpatialObjectRegistrationMethod.h:125
itk::ImageToSpatialObjectRegistrationMethod::m_InitialTransformParameters
ParametersType m_InitialTransformParameters
Definition: itkImageToSpatialObjectRegistrationMethod.h:208
itk::Optimizer
Generic representation for an optimization method.
Definition: itkOptimizer.h:38
itkImage.h
itk::ImageToSpatialObjectRegistrationMethod::m_Metric
MetricPointer m_Metric
Definition: itkImageToSpatialObjectRegistrationMethod.h:212
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ProcessObject::DataObjectPointerArraySizeType
DataObjectPointerArray::size_type DataObjectPointerArraySizeType
Definition: itkProcessObject.h:193
itk::ImageToSpatialObjectRegistrationMethod::FixedImageConstPointer
typename FixedImageType::ConstPointer FixedImageConstPointer
Definition: itkImageToSpatialObjectRegistrationMethod.h:104
itk::DataObjectDecorator
Decorates any subclass of itkObject with a DataObject API.
Definition: itkDataObjectDecorator.h:66
itk::ImageToSpatialObjectRegistrationMethod::m_LastTransformParameters
ParametersType m_LastTransformParameters
Definition: itkImageToSpatialObjectRegistrationMethod.h:209
itk::ImageToSpatialObjectRegistrationMethod::TransformType
typename MetricType::TransformType TransformType
Definition: itkImageToSpatialObjectRegistrationMethod.h:115
itk::LinearInterpolateImageFunction
Linearly interpolate an image at specified positions.
Definition: itkLinearInterpolateImageFunction.h:50
itk::ImageToSpatialObjectRegistrationMethod::TransformOutputConstPointer
typename TransformOutputType::ConstPointer TransformOutputConstPointer
Definition: itkImageToSpatialObjectRegistrationMethod.h:122
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::ImageToSpatialObjectRegistrationMethod::InterpolatorPointer
typename InterpolatorType::Pointer InterpolatorPointer
Definition: itkImageToSpatialObjectRegistrationMethod.h:126
itkProcessObject.h
itk::ImageToSpatialObjectRegistrationMethod::TransformPointer
typename TransformType::Pointer TransformPointer
Definition: itkImageToSpatialObjectRegistrationMethod.h:116
itkDataObjectDecorator.h
itk::ImageToSpatialObjectRegistrationMethod::FixedImageType
TFixedImage FixedImageType
Definition: itkImageToSpatialObjectRegistrationMethod.h:103
itk::ImageToSpatialObjectRegistrationMethod::m_MovingSpatialObject
MovingSpatialObjectConstPointer m_MovingSpatialObject
Definition: itkImageToSpatialObjectRegistrationMethod.h:215
itk::ImageToSpatialObjectRegistrationMethod::ParametersType
typename MetricType::TransformParametersType ParametersType
Definition: itkImageToSpatialObjectRegistrationMethod.h:133
itk::ImageToSpatialObjectRegistrationMethod::m_Transform
TransformPointer m_Transform
Definition: itkImageToSpatialObjectRegistrationMethod.h:218
itk::ImageToSpatialObjectRegistrationMethod::MetricPointer
typename MetricType::Pointer MetricPointer
Definition: itkImageToSpatialObjectRegistrationMethod.h:112
itk::ImageToSpatialObjectRegistrationMethod::m_FixedImage
FixedImageConstPointer m_FixedImage
Definition: itkImageToSpatialObjectRegistrationMethod.h:216
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ImageToSpatialObjectRegistrationMethod::m_Interpolator
InterpolatorPointer m_Interpolator
Definition: itkImageToSpatialObjectRegistrationMethod.h:219
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ProcessObject
class ITK_FORWARD_EXPORT ProcessObject
Definition: itkDataObject.h:41
itk::ImageToSpatialObjectMetric::TransformParametersType
typename TransformType::ParametersType TransformParametersType
Definition: itkImageToSpatialObjectMetric.h:92
itk::Transform
Transform points and vectors from an input space to an output space.
Definition: itkTransform.h:82
itk::ImageToSpatialObjectRegistrationMethod::TransformOutputPointer
typename TransformOutputType::Pointer TransformOutputPointer
Definition: itkImageToSpatialObjectRegistrationMethod.h:121
itkSingleValuedNonLinearOptimizer.h
itk::DataObject::Pointer
SmartPointer< Self > Pointer
Definition: itkDataObject.h:301
itk::ImageToSpatialObjectMetric
Computes similarity between a moving spatial object and an Image to be registered.
Definition: itkImageToSpatialObjectMetric.h:61
itk::ImageToSpatialObjectRegistrationMethod::m_Optimizer
OptimizerType::Pointer m_Optimizer
Definition: itkImageToSpatialObjectRegistrationMethod.h:213