ITK  5.2.0
Insight Toolkit
itkMultiResolutionPyramidImageFilter.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 itkMultiResolutionPyramidImageFilter_h
19 #define itkMultiResolutionPyramidImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 #include "itkArray2D.h"
23 
24 namespace itk
25 {
108 template <typename TInputImage, typename TOutputImage>
109 class ITK_TEMPLATE_EXPORT MultiResolutionPyramidImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
110 {
111 public:
112  ITK_DISALLOW_COPY_AND_ASSIGN(MultiResolutionPyramidImageFilter);
113 
119 
121  itkNewMacro(Self);
122 
125 
128 
130  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
131  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
132 
134  using InputImageType = typename Superclass::InputImageType;
135  using OutputImageType = typename Superclass::OutputImageType;
136  using InputImagePointer = typename Superclass::InputImagePointer;
137  using OutputImagePointer = typename Superclass::OutputImagePointer;
138  using InputImageConstPointer = typename Superclass::InputImageConstPointer;
139 
146  virtual void
147  SetNumberOfLevels(unsigned int num);
148 
150  itkGetConstMacro(NumberOfLevels, unsigned int);
151 
158  virtual void
159  SetSchedule(const ScheduleType & schedule);
160 
162  itkGetConstReferenceMacro(Schedule, ScheduleType);
163 
168  virtual void
169  SetStartingShrinkFactors(unsigned int factor);
170 
171  virtual void
172  SetStartingShrinkFactors(const unsigned int * factors);
173 
175  const unsigned int *
176  GetStartingShrinkFactors() const;
177 
181  static bool
182  IsScheduleDownwardDivisible(const ScheduleType & schedule);
183 
190  void
191  GenerateOutputInformation() override;
192 
197  void
198  GenerateOutputRequestedRegion(DataObject * output) override;
200 
207  void
208  GenerateInputRequestedRegion() override;
209 
210  itkSetMacro(MaximumError, double);
211  itkGetConstReferenceMacro(MaximumError, double);
212 
213  itkSetMacro(UseShrinkImageFilter, bool);
214  itkGetConstMacro(UseShrinkImageFilter, bool);
215  itkBooleanMacro(UseShrinkImageFilter);
216 
217 #ifdef ITK_USE_CONCEPT_CHECKING
218  // Begin concept checking
221  // End concept checking
222 #endif
223 
224 protected:
226  ~MultiResolutionPyramidImageFilter() override = default;
227  void
228  PrintSelf(std::ostream & os, Indent indent) const override;
229 
231  void
232  GenerateData() override;
233 
235 
236  unsigned int m_NumberOfLevels;
238 
240 };
241 } // namespace itk
242 
243 #ifndef ITK_MANUAL_INSTANTIATION
244 # include "itkMultiResolutionPyramidImageFilter.hxx"
245 #endif
246 
247 #endif
itk::Concept::HasNumericTraits
Definition: itkConceptChecking.h:712
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::MultiResolutionPyramidImageFilter::m_NumberOfLevels
unsigned int m_NumberOfLevels
Definition: itkMultiResolutionPyramidImageFilter.h:236
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::MultiResolutionPyramidImageFilter::m_Schedule
ScheduleType m_Schedule
Definition: itkMultiResolutionPyramidImageFilter.h:237
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::MultiResolutionPyramidImageFilter::m_UseShrinkImageFilter
bool m_UseShrinkImageFilter
Definition: itkMultiResolutionPyramidImageFilter.h:239
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itkImageToImageFilter.h
itk::MultiResolutionPyramidImageFilter::m_MaximumError
double m_MaximumError
Definition: itkMultiResolutionPyramidImageFilter.h:234
itkArray2D.h
itkConceptMacro
#define itkConceptMacro(name, concept)
Definition: itkConceptChecking.h:64
itk::MultiResolutionPyramidImageFilter
Framework for creating images in a multi-resolution pyramid.
Definition: itkMultiResolutionPyramidImageFilter.h:109
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::Array2D< unsigned int >
itk::ImageToImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkImageToImageFilter.h:131
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90
itk::DataObject
Base class for all data objects in ITK.
Definition: itkDataObject.h:293