ITK  5.2.0
Insight Toolkit
itkInterpolateImageFilter.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 itkInterpolateImageFilter_h
19 #define itkInterpolateImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
23 
24 namespace itk
25 {
44 template <typename TInputImage, typename TOutputImage>
45 class ITK_TEMPLATE_EXPORT InterpolateImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
46 {
47 public:
48  ITK_DISALLOW_COPY_AND_ASSIGN(InterpolateImageFilter);
49 
55 
57  itkNewMacro(Self);
58 
61 
63  using InputImageType = typename Superclass::InputImageType;
64  using InputImagePointer = typename Superclass::InputImagePointer;
65  using OutputImageType = typename Superclass::OutputImageType;
66  using OutputImagePointer = typename Superclass::OutputImagePointer;
67  using OutputImageRegionType = typename Superclass::OutputImageRegionType;
68 
70  static constexpr unsigned int ImageDimension = TOutputImage::ImageDimension;
71  static constexpr unsigned int IntermediateImageDimension = TOutputImage::ImageDimension + 1;
72 
74  using InputPixelType = typename TInputImage::PixelType;
77 
79  void
80  SetInput1(const InputImageType * image)
81  {
82  this->SetInput(image);
83  }
84  const InputImageType *
86  {
87  return this->GetInput();
88  }
90 
92  void
93  SetInput2(const InputImageType * image);
94 
95  const InputImageType *
96  GetInput2();
97 
100  itkSetClampMacro(Distance, double, 0.0, 1.0);
101  itkGetConstMacro(Distance, double);
103 
105  itkSetObjectMacro(Interpolator, InterpolatorType) itkGetModifiableObjectMacro(Interpolator, InterpolatorType);
106 
109  void
110  BeforeThreadedGenerateData() override;
111 
113  void
114  AfterThreadedGenerateData() override;
115 
116 #ifdef ITK_USE_CONCEPT_CHECKING
117  // Begin concept checking
118  itkConceptMacro(InputHasNumericTraitsCheck, (Concept::HasNumericTraits<InputPixelType>));
119  // End concept checking
120 #endif
121 
122 protected:
124  ~InterpolateImageFilter() override = default;
125  void
126  PrintSelf(std::ostream & os, Indent indent) const override;
127 
129  void
130  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
131 
132 
133 private:
135 
137 
138  double m_Distance;
139 };
140 } // end namespace itk
141 
142 #ifndef ITK_MANUAL_INSTANTIATION
143 # include "itkInterpolateImageFilter.hxx"
144 #endif
145 
146 #endif
itk::Concept::HasNumericTraits
Definition: itkConceptChecking.h:712
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itkLinearInterpolateImageFunction.h
itk::InterpolateImageFilter::m_IntermediateImage
IntermediateImageType::Pointer m_IntermediateImage
Definition: itkInterpolateImageFilter.h:136
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::InterpolateImageFilter::GetInput1
const InputImageType * GetInput1()
Definition: itkInterpolateImageFilter.h:85
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::InterpolateImageFilter::InputPixelType
typename TInputImage::PixelType InputPixelType
Definition: itkInterpolateImageFilter.h:74
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::InterpolateImageFilter::m_Interpolator
InterpolatorType::Pointer m_Interpolator
Definition: itkInterpolateImageFilter.h:134
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itkImageToImageFilter.h
itk::InterpolateImageFilter
Interpolate an image from two N-D images.
Definition: itkInterpolateImageFilter.h:45
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itk::InterpolateImageFilter::m_Distance
double m_Distance
Definition: itkInterpolateImageFilter.h:138
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::Image
Templated n-dimensional image class.
Definition: itkImage.h:86
itk::InterpolateImageFilter::SetInput1
void SetInput1(const InputImageType *image)
Definition: itkInterpolateImageFilter.h:80
itk::InterpolateImageFunction
Base class for all image interpolators.
Definition: itkInterpolateImageFunction.h:45
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90