ITK  5.0.0
Insight Segmentation and Registration Toolkit
itkCyclicShiftImageFilter.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 #ifndef itkCyclicShiftImageFilter_h
19 #define itkCyclicShiftImageFilter_h
20 
21 #include "itkImageToImageFilter.h"
22 
23 namespace itk
24 {
45 template< typename TInputImage, typename TOutputImage = TInputImage >
46 class ITK_TEMPLATE_EXPORT CyclicShiftImageFilter:
47  public ImageToImageFilter< TInputImage, TOutputImage >
48 {
49 public:
50  ITK_DISALLOW_COPY_AND_ASSIGN(CyclicShiftImageFilter);
51 
57 
59  using InputImageType = TInputImage;
60  using OutputImageType = TOutputImage;
61  using InputImagePointer = typename InputImageType::Pointer;
62  using InputImageConstPointer = typename InputImageType::ConstPointer;
64  using InputImagePixelType = typename InputImageType::PixelType;
65  using OutputImagePointer = typename OutputImageType::Pointer;
66  using OutputImageConstPointer = typename OutputImageType::ConstPointer;
68  using OutputImagePixelType = typename OutputImageType::PixelType;
71  using OffsetType = typename OutputImageType::OffsetType;
73 
75  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
76 
78  itkNewMacro(Self);
79 
82 
84  itkSetMacro(Shift, OffsetType);
85  itkGetConstMacro(Shift, OffsetType);
87 
88 protected:
90  ~CyclicShiftImageFilter() override = default;
91  void PrintSelf(std::ostream & os, Indent indent) const override;
92 
95  void GenerateInputRequestedRegion() override;
96 
98  void DynamicThreadedGenerateData(const OutputImageRegionType &) override;
99 
100 
104 }; // end of class
105 } // end namespace itk
106 
107 #ifndef ITK_MANUAL_INSTANTIATION
108 #include "itkCyclicShiftImageFilter.hxx"
109 #endif
110 
111 
112 #endif
typename OutputImageType::Pointer OutputImagePointer
typename OutputImageType::ConstPointer OutputImageConstPointer
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Base class for all process objects that output image data.
typename OutputImageType::PixelType OutputImagePixelType
typename InputImageType::PixelType InputImagePixelType
typename InputImageType::Pointer InputImagePointer
typename OutputImageType::RegionType OutputImageRegionType
TOutputImage OutputImageType
typename OutputImageType::OffsetValueType OffsetValueType
typename InputImageType::RegionType InputImageRegionType
Base class for filters that take an image as input and produce an image as output.
Control indentation during Print() invocation.
Definition: itkIndent.h:49
Perform a cyclic spatial shift of image intensities on the image grid.
typename OutputImageType::OffsetType OffsetType
typename OutputImageType::SizeType SizeType
typename InputImageType::ConstPointer InputImageConstPointer
signed long OffsetValueType
Definition: itkIntTypes.h:94
typename OutputImageType::IndexType IndexType