ITK  5.0.0
Insight Segmentation and Registration Toolkit
itkShrinkImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 {
66 template< typename TInputImage, typename TOutputImage >
67 class ITK_TEMPLATE_EXPORT ShrinkImageFilter:
68  public ImageToImageFilter< TInputImage, TOutputImage >
69 {
70 public:
71  ITK_DISALLOW_COPY_AND_ASSIGN(ShrinkImageFilter);
72 
78 
80  itkNewMacro(Self);
81 
84 
86  using OutputImageType = TOutputImage;
87  using InputImageType = TInputImage;
88  using OutputImagePointer = typename OutputImageType::Pointer;
89  using InputImagePointer = typename InputImageType::Pointer;
90  using InputImageConstPointer = typename InputImageType::ConstPointer;
91 
94  using OutputOffsetType = typename TOutputImage::OffsetType;
95 
98 
100  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
101  static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension;
102 
104 
107  itkSetMacro(ShrinkFactors, ShrinkFactorsType);
108  void SetShrinkFactors(unsigned int factor);
109  void SetShrinkFactor(unsigned int i, unsigned int factor);
111 
113  itkGetConstReferenceMacro(ShrinkFactors, ShrinkFactorsType);
114 
122  void GenerateOutputInformation() override;
123 
129  void GenerateInputRequestedRegion() override;
130 
131 #ifdef ITK_USE_CONCEPT_CHECKING
132  // Begin concept checking
133  itkConceptMacro( InputConvertibleToOutputCheck,
135  itkConceptMacro( SameDimensionCheck,
137  // End concept checking
138 #endif
139 
140 protected:
142  ~ShrinkImageFilter() override = default;
143  void PrintSelf(std::ostream & os, Indent indent) const override;
144 
155  void DynamicThreadedGenerateData(const OutputImageRegionType & outputRegionForThread) override;
156 
157 
158 private:
160 };
161 } // end namespace itk
162 
163 #ifndef ITK_MANUAL_INSTANTIATION
164 #include "itkShrinkImageFilter.hxx"
165 #endif
166 
167 #endif
typename OutputImageType::Pointer OutputImagePointer
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
typename TOutputImage::OffsetType OutputOffsetType
Base class for all process objects that output image data.
typename InputImageType::Pointer InputImagePointer
typename OutputImageType::RegionType OutputImageRegionType
TOutputImage OutputImageType
typename TOutputImage::IndexType OutputIndexType
Base class for filters that take an image as input and produce an image as output.
typename TInputImage::IndexType InputIndexType
Control indentation during Print() invocation.
Definition: itkIndent.h:49
ShrinkFactorsType m_ShrinkFactors
Reduce the size of an image by an integer factor in each dimension.
#define itkConceptMacro(name, concept)
typename InputImageType::ConstPointer InputImageConstPointer