ITK  5.2.0
Insight Toolkit
itkExponentialDisplacementFieldImageFilter.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 itkExponentialDisplacementFieldImageFilter_h
19 #define itkExponentialDisplacementFieldImageFilter_h
20 
21 #include "itkDivideImageFilter.h"
22 #include "itkCastImageFilter.h"
25 #include "itkAddImageFilter.h"
26 
27 namespace itk
28 {
61 template <typename TInputImage, typename TOutputImage>
62 class ITK_TEMPLATE_EXPORT ExponentialDisplacementFieldImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
63 {
64 public:
65  ITK_DISALLOW_COPY_AND_ASSIGN(ExponentialDisplacementFieldImageFilter);
66 
72 
74  itkNewMacro(Self);
75 
78 
80  using InputImageType = TInputImage;
81  using InputImagePointer = typename InputImageType::Pointer;
82  using InputImageConstPointer = typename InputImageType::ConstPointer;
83  using InputPixelType = typename InputImageType::PixelType;
84  using InputPixelRealValueType = typename InputPixelType::RealValueType;
85 
86  using OutputImageType = TOutputImage;
87  using OutputImagePointer = typename OutputImageType::Pointer;
88  using OutputPixelType = typename OutputImageType::PixelType;
89 
91  itkSetMacro(MaximumNumberOfIterations, unsigned int);
92  itkGetConstMacro(MaximumNumberOfIterations, unsigned int);
94 
99  itkSetMacro(AutomaticNumberOfIterations, bool);
100  itkGetConstMacro(AutomaticNumberOfIterations, bool);
101  itkBooleanMacro(AutomaticNumberOfIterations);
103 
109  itkSetMacro(ComputeInverse, bool);
110  itkGetConstMacro(ComputeInverse, bool);
111  itkBooleanMacro(ComputeInverse);
113 
115  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
116  static constexpr unsigned int OutputImageDimension = TInputImage::ImageDimension;
117  static constexpr unsigned int PixelDimension = InputPixelType::Dimension;
118  static constexpr unsigned int OutputPixelDimension = OutputPixelType::Dimension;
119 
120 #ifdef ITK_USE_CONCEPT_CHECKING
121  // Begin concept checking
126  // End concept checking
127 #endif
128 
129 protected:
131  ~ExponentialDisplacementFieldImageFilter() override = default;
132 
133  void
134  PrintSelf(std::ostream & os, Indent indent) const override;
135 
139  void
140  GenerateData() override;
141 
143 
144  using DivideByConstantType =
146 
148 
150 
152 
154 
161 
162 private:
165 
167 
172 };
173 } // end namespace itk
174 
175 #ifndef ITK_MANUAL_INSTANTIATION
176 # include "itkExponentialDisplacementFieldImageFilter.hxx"
177 #endif
178 
179 #endif
itk::ExponentialDisplacementFieldImageFilter::m_AutomaticNumberOfIterations
bool m_AutomaticNumberOfIterations
Definition: itkExponentialDisplacementFieldImageFilter.h:163
itk::CastImageFilter
Casts input pixels to output pixel type.
Definition: itkCastImageFilter.h:104
itk::DivideImageFilter
Pixel-wise division of two images.
Definition: itkDivideImageFilter.h:48
itk::Concept::HasNumericTraits
Definition: itkConceptChecking.h:712
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itkWarpVectorImageFilter.h
itk::ExponentialDisplacementFieldImageFilter::FieldInterpolatorOutputType
typename FieldInterpolatorType::OutputType FieldInterpolatorOutputType
Definition: itkExponentialDisplacementFieldImageFilter.h:159
itk::ExponentialDisplacementFieldImageFilter::m_MaximumNumberOfIterations
unsigned int m_MaximumNumberOfIterations
Definition: itkExponentialDisplacementFieldImageFilter.h:164
itk::ExponentialDisplacementFieldImageFilter::VectorWarperPointer
typename VectorWarperType::Pointer VectorWarperPointer
Definition: itkExponentialDisplacementFieldImageFilter.h:157
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itkCastImageFilter.h
itkDivideImageFilter.h
itk::ExponentialDisplacementFieldImageFilter::m_Adder
AdderPointer m_Adder
Definition: itkExponentialDisplacementFieldImageFilter.h:171
itk::Concept::SameDimension
Definition: itkConceptChecking.h:692
itk::ImageToImageFilter
Base class for filters that take an image as input and produce an image as output.
Definition: itkImageToImageFilter.h:108
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::ExponentialDisplacementFieldImageFilter::InputPixelType
typename InputImageType::PixelType InputPixelType
Definition: itkExponentialDisplacementFieldImageFilter.h:83
itk::ExponentialDisplacementFieldImageFilter::m_Divider
DivideByConstantPointer m_Divider
Definition: itkExponentialDisplacementFieldImageFilter.h:168
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::ExponentialDisplacementFieldImageFilter::FieldInterpolatorPointer
typename FieldInterpolatorType::Pointer FieldInterpolatorPointer
Definition: itkExponentialDisplacementFieldImageFilter.h:158
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::ExponentialDisplacementFieldImageFilter::OutputPixelType
typename OutputImageType::PixelType OutputPixelType
Definition: itkExponentialDisplacementFieldImageFilter.h:88
itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h
itk::ExponentialDisplacementFieldImageFilter::AdderPointer
typename AdderType::Pointer AdderPointer
Definition: itkExponentialDisplacementFieldImageFilter.h:160
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction
Linearly interpolate or NN extrapolate a vector image at specified positions.
Definition: itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h:54
itk::ExponentialDisplacementFieldImageFilter::DivideByConstantPointer
typename DivideByConstantType::Pointer DivideByConstantPointer
Definition: itkExponentialDisplacementFieldImageFilter.h:155
itk::ExponentialDisplacementFieldImageFilter::CasterPointer
typename CasterType::Pointer CasterPointer
Definition: itkExponentialDisplacementFieldImageFilter.h:156
itk::ExponentialDisplacementFieldImageFilter
Computes a diffeomorphic displacement field as the Lie group exponential of a vector field.
Definition: itkExponentialDisplacementFieldImageFilter.h:62
itk::ExponentialDisplacementFieldImageFilter::m_Caster
CasterPointer m_Caster
Definition: itkExponentialDisplacementFieldImageFilter.h:169
itk::WarpVectorImageFilter
Warps an image using an input displacement field.
Definition: itkWarpVectorImageFilter.h:89
itk::ExponentialDisplacementFieldImageFilter::m_ComputeInverse
bool m_ComputeInverse
Definition: itkExponentialDisplacementFieldImageFilter.h:166
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:64
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ExponentialDisplacementFieldImageFilter::m_Warper
VectorWarperPointer m_Warper
Definition: itkExponentialDisplacementFieldImageFilter.h:170
itkAddImageFilter.h
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ExponentialDisplacementFieldImageFilter::InputPixelRealValueType
typename InputPixelType::RealValueType InputPixelRealValueType
Definition: itkExponentialDisplacementFieldImageFilter.h:84
itk::ExponentialDisplacementFieldImageFilter::RegionType
typename InputImageType::RegionType RegionType
Definition: itkExponentialDisplacementFieldImageFilter.h:142
itk::AddImageFilter
Pixel-wise addition of two images.
Definition: itkAddImageFilter.h:80
itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction::OutputType
typename Superclass::OutputType OutputType
Definition: itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h:94
itk::GTest::TypedefsAndConstructors::Dimension2::Dimension
constexpr unsigned int Dimension
Definition: itkGTestTypedefsAndConstructors.h:44
itk::ImageToImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkImageToImageFilter.h:131
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90