ITK  5.2.0
Insight Toolkit
itkShrinkImageFilter.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 /*=========================================================================
19  *
20  * Portions of this file are subject to the VTK Toolkit Version 3 copyright.
21  *
22  * Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
23  *
24  * For complete copyright, license and disclaimer of warranty information
25  * please refer to the NOTICE file at the top of the ITK source tree.
26  *
27  *=========================================================================*/
28 #ifndef itkShrinkImageFilter_h
29 #define itkShrinkImageFilter_h
30 
31 #include "itkImageToImageFilter.h"
32 
33 namespace itk
34 {
67 template <typename TInputImage, typename TOutputImage>
68 class ITK_TEMPLATE_EXPORT ShrinkImageFilter : public ImageToImageFilter<TInputImage, TOutputImage>
69 {
70 public:
71  ITK_DISALLOW_COPY_AND_ASSIGN(ShrinkImageFilter);
73 
79 
81  itkNewMacro(Self);
82 
85 
87  using OutputImageType = TOutputImage;
88  using InputImageType = TInputImage;
89  using OutputImagePointer = typename OutputImageType::Pointer;
90  using InputImagePointer = typename InputImageType::Pointer;
91  using InputImageConstPointer = typename InputImageType::ConstPointer;
92 
95  using OutputOffsetType = typename TOutputImage::OffsetType;
96 
99 
101  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
102  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
103 
105 
108  itkSetMacro(ShrinkFactors, ShrinkFactorsType);
109  void
110  SetShrinkFactors(unsigned int factor);
111  void
112  SetShrinkFactor(unsigned int i, unsigned int factor);
114 
116  itkGetConstReferenceMacro(ShrinkFactors, ShrinkFactorsType);
117 
125  void
126  GenerateOutputInformation() override;
127 
133  void
134  GenerateInputRequestedRegion() override;
135 
136 #ifdef ITK_USE_CONCEPT_CHECKING
137  // Begin concept checking
138  itkConceptMacro(InputConvertibleToOutputCheck,
141  // End concept checking
142 #endif
143 
144 protected:
146  ~ShrinkImageFilter() override = default;
147  void
148  PrintSelf(std::ostream & os, Indent indent) const override;
149 
160  void
161  DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
162 
163 
164 private:
166 };
167 } // end namespace itk
168 
169 #ifndef ITK_MANUAL_INSTANTIATION
170 # include "itkShrinkImageFilter.hxx"
171 #endif
172 
173 #endif
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ShrinkImageFilter::OutputIndexType
typename TOutputImage::IndexType OutputIndexType
Definition: itkShrinkImageFilter.h:93
itk::Concept::SameDimension
Definition: itkConceptChecking.h:692
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::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::ShrinkImageFilter::InputIndexType
typename TInputImage::IndexType InputIndexType
Definition: itkShrinkImageFilter.h:94
itk::ShrinkImageFilter
Reduce the size of an image by an integer factor in each dimension.
Definition: itkShrinkImageFilter.h:68
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itkImageToImageFilter.h
itk::FixedArray< unsigned int, ImageDimension >
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
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::Concept::Convertible
Definition: itkConceptChecking.h:214
itk::ShrinkImageFilter::m_ShrinkFactors
ShrinkFactorsType m_ShrinkFactors
Definition: itkShrinkImageFilter.h:165
itk::ShrinkImageFilter::OutputOffsetType
typename TOutputImage::OffsetType OutputOffsetType
Definition: itkShrinkImageFilter.h:95
itk::ImageToImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkImageToImageFilter.h:131
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90