ITK  5.2.0
Insight Toolkit
itkWarpVectorImageFilter.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 itkWarpVectorImageFilter_h
19 #define itkWarpVectorImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
23 #include "itkPoint.h"
24 #include "itkFixedArray.h"
25 
26 namespace itk
27 {
88 template <typename TInputImage, typename TOutputImage, typename TDisplacementField>
89 class ITK_TEMPLATE_EXPORT WarpVectorImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
90 {
91 public:
92  ITK_DISALLOW_COPY_AND_ASSIGN(WarpVectorImageFilter);
93 
99 
101  itkNewMacro(Self);
102 
105 
108 
110  using InputImageType = typename Superclass::InputImageType;
111  using InputImagePointer = typename Superclass::InputImagePointer;
112  using OutputImageType = typename Superclass::OutputImageType;
113  using OutputImagePointer = typename Superclass::OutputImagePointer;
114  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
115 
118  using PixelType = typename OutputImageType::PixelType;
119  using SpacingType = typename OutputImageType::SpacingType;
120  using ValueType = typename OutputImageType::PixelType::ValueType;
121 
123  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;
124 
126  static constexpr unsigned int PixelDimension = PixelType::Dimension;
127 
129  using DisplacementFieldType = TDisplacementField;
130  using DisplacementFieldPointer = typename DisplacementFieldType::Pointer;
131  using DisplacementType = typename DisplacementFieldType::PixelType;
132 
134  using CoordRepType = double;
138 
141 
144 
146  void
147  SetDisplacementField(const DisplacementFieldType * field);
148 
150  void
151  SetDisplacementField(DisplacementFieldType * field);
152 
155  GetDisplacementField();
156 
158  itkSetObjectMacro(Interpolator, InterpolatorType);
159  itkGetModifiableObjectMacro(Interpolator, InterpolatorType);
161 
163  itkSetMacro(OutputSpacing, SpacingType);
164  virtual void
165  SetOutputSpacing(const double * values);
167 
169  itkGetConstReferenceMacro(OutputSpacing, SpacingType);
170 
172  itkSetMacro(OutputOrigin, PointType);
173  virtual void
174  SetOutputOrigin(const double * values);
176 
178  itkGetConstReferenceMacro(OutputOrigin, PointType);
179 
181  itkSetMacro(OutputDirection, DirectionType);
182  itkGetConstReferenceMacro(OutputDirection, DirectionType);
184 
186  itkSetMacro(EdgePaddingValue, PixelType);
187 
189  itkGetConstMacro(EdgePaddingValue, PixelType);
190 
196  void
197  GenerateOutputInformation() override;
198 
205  void
206  GenerateInputRequestedRegion() override;
207 
210  void
211  BeforeThreadedGenerateData() override;
212 
213 #ifdef ITK_USE_CONCEPT_CHECKING
214  // Begin concept checking
216  itkConceptMacro(OutputHasNumericTraitsCheck, (Concept::HasNumericTraits<ValueType>));
217  itkConceptMacro(DisplacementFieldHasNumericTraitsCheck,
219  // End concept checking
220 #endif
221 
222 protected:
224  ~WarpVectorImageFilter() override = default;
225  void
226  PrintSelf(std::ostream & os, Indent indent) const override;
227 
231  void
232  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
233 
234 
235 private:
240 
242 };
243 } // end namespace itk
244 
245 #ifndef ITK_MANUAL_INSTANTIATION
246 # include "itkWarpVectorImageFilter.hxx"
247 #endif
248 
249 #endif
itk::WarpVectorImageFilter::DisplacementType
typename DisplacementFieldType::PixelType DisplacementType
Definition: itkWarpVectorImageFilter.h:131
itk::WarpVectorImageFilter::m_EdgePaddingValue
PixelType m_EdgePaddingValue
Definition: itkWarpVectorImageFilter.h:236
itk::GTest::TypedefsAndConstructors::Dimension2::DirectionType
ImageBaseType::DirectionType DirectionType
Definition: itkGTestTypedefsAndConstructors.h:52
itk::Concept::HasNumericTraits
Definition: itkConceptChecking.h:712
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::WarpVectorImageFilter::CoordRepType
double CoordRepType
Definition: itkWarpVectorImageFilter.h:134
itkPoint.h
itk::WarpVectorImageFilter::m_OutputOrigin
PointType m_OutputOrigin
Definition: itkWarpVectorImageFilter.h:238
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itkVectorLinearInterpolateImageFunction.h
itk::VectorInterpolateImageFunction
Base class for all vector image interpolators.
Definition: itkVectorInterpolateImageFunction.h:47
itk::WarpVectorImageFilter::DirectionType
typename TOutputImage::DirectionType DirectionType
Definition: itkWarpVectorImageFilter.h:143
itk::WarpVectorImageFilter::m_OutputDirection
DirectionType m_OutputDirection
Definition: itkWarpVectorImageFilter.h:239
itk::GTest::TypedefsAndConstructors::Dimension2::IndexType
ImageBaseType::IndexType IndexType
Definition: itkGTestTypedefsAndConstructors.h:50
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::WarpVectorImageFilter::DisplacementFieldType
TDisplacementField DisplacementFieldType
Definition: itkWarpVectorImageFilter.h:129
itk::WarpVectorImageFilter::ValueType
typename OutputImageType::PixelType::ValueType ValueType
Definition: itkWarpVectorImageFilter.h:120
itk::WarpVectorImageFilter::m_Interpolator
InterpolatorPointer m_Interpolator
Definition: itkWarpVectorImageFilter.h:241
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itkFixedArray.h
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itkImageToImageFilter.h
itk::WarpVectorImageFilter::IndexType
typename OutputImageType::IndexType IndexType
Definition: itkWarpVectorImageFilter.h:116
itk::WarpVectorImageFilter::PixelType
typename OutputImageType::PixelType PixelType
Definition: itkWarpVectorImageFilter.h:118
itk::WarpVectorImageFilter
Warps an image using an input displacement field.
Definition: itkWarpVectorImageFilter.h:89
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itk::WarpVectorImageFilter::InterpolatorPointer
typename InterpolatorType::Pointer InterpolatorPointer
Definition: itkWarpVectorImageFilter.h:136
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::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::WarpVectorImageFilter::SizeType
typename OutputImageType::SizeType SizeType
Definition: itkWarpVectorImageFilter.h:117
itk::Point< CoordRepType, Self::ImageDimension >
itk::WarpVectorImageFilter::SpacingType
typename OutputImageType::SpacingType SpacingType
Definition: itkWarpVectorImageFilter.h:119
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
itk::WarpVectorImageFilter::m_OutputSpacing
SpacingType m_OutputSpacing
Definition: itkWarpVectorImageFilter.h:237
itk::VectorLinearInterpolateImageFunction
Linearly interpolate a vector image at specified positions.
Definition: itkVectorLinearInterpolateImageFunction.h:43
itk::WarpVectorImageFilter::DisplacementFieldPointer
typename DisplacementFieldType::Pointer DisplacementFieldPointer
Definition: itkWarpVectorImageFilter.h:130