ITK  5.2.0
Insight Toolkit
itkCyclicShiftImageFilter.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 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 : public ImageToImageFilter<TInputImage, TOutputImage>
47 {
48 public:
49  ITK_DISALLOW_COPY_AND_ASSIGN(CyclicShiftImageFilter);
50 
56 
58  using InputImageType = TInputImage;
59  using OutputImageType = TOutputImage;
60  using InputImagePointer = typename InputImageType::Pointer;
61  using InputImageConstPointer = typename InputImageType::ConstPointer;
63  using InputImagePixelType = typename InputImageType::PixelType;
64  using OutputImagePointer = typename OutputImageType::Pointer;
65  using OutputImageConstPointer = typename OutputImageType::ConstPointer;
67  using OutputImagePixelType = typename OutputImageType::PixelType;
70  using OffsetType = typename OutputImageType::OffsetType;
72 
74  static constexpr unsigned int ImageDimension = TInputImage::ImageDimension;
75 
77  itkNewMacro(Self);
78 
81 
83  itkSetMacro(Shift, OffsetType);
84  itkGetConstMacro(Shift, OffsetType);
86 
87 protected:
89  ~CyclicShiftImageFilter() override = default;
90  void
91  PrintSelf(std::ostream & os, Indent indent) const override;
92 
95  void
96  GenerateInputRequestedRegion() override;
97 
99  void
100  DynamicThreadedGenerateData(const OutputImageRegionType &) override;
101 
102 
106 }; // end of class
107 } // end namespace itk
108 
109 #ifndef ITK_MANUAL_INSTANTIATION
110 # include "itkCyclicShiftImageFilter.hxx"
111 #endif
112 
113 
114 #endif
itk::CyclicShiftImageFilter::OutputImageConstPointer
typename OutputImageType::ConstPointer OutputImageConstPointer
Definition: itkCyclicShiftImageFilter.h:65
itk::ImageSource::OutputImagePointer
typename OutputImageType::Pointer OutputImagePointer
Definition: itkImageSource.h:91
itk::CyclicShiftImageFilter::SizeType
typename OutputImageType::SizeType SizeType
Definition: itkCyclicShiftImageFilter.h:69
itk::GTest::TypedefsAndConstructors::Dimension2::SizeType
ImageBaseType::SizeType SizeType
Definition: itkGTestTypedefsAndConstructors.h:49
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::CyclicShiftImageFilter::IndexType
typename OutputImageType::IndexType IndexType
Definition: itkCyclicShiftImageFilter.h:68
itk::ImageToImageFilter::InputImagePixelType
typename InputImageType::PixelType InputImagePixelType
Definition: itkImageToImageFilter.h:133
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::CyclicShiftImageFilter::OffsetType
typename OutputImageType::OffsetType OffsetType
Definition: itkCyclicShiftImageFilter.h:70
itk::ImageSource
Base class for all process objects that output image data.
Definition: itkImageSource.h:67
itk::CyclicShiftImageFilter::m_Shift
OffsetType m_Shift
Definition: itkCyclicShiftImageFilter.h:105
itk::ImageToImageFilter::InputImagePointer
typename InputImageType::Pointer InputImagePointer
Definition: itkImageToImageFilter.h:130
itk::GTest::TypedefsAndConstructors::Dimension2::RegionType
ImageBaseType::RegionType RegionType
Definition: itkGTestTypedefsAndConstructors.h:54
itk::ImageToImageFilter::InputImageType
TInputImage InputImageType
Definition: itkImageToImageFilter.h:129
itkImageToImageFilter.h
itk::ImageSource::OutputImageRegionType
typename OutputImageType::RegionType OutputImageRegionType
Definition: itkImageSource.h:92
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::CyclicShiftImageFilter::OffsetValueType
typename OutputImageType::OffsetValueType OffsetValueType
Definition: itkCyclicShiftImageFilter.h:71
itk::OffsetValueType
signed long OffsetValueType
Definition: itkIntTypes.h:94
itk::ProcessObject
The base class for all process objects (source, filters, mappers) in the Insight data processing pipe...
Definition: itkProcessObject.h:138
itk::ImageSource::OutputImagePixelType
typename OutputImageType::PixelType OutputImagePixelType
Definition: itkImageSource.h:93
itk::CyclicShiftImageFilter
Perform a cyclic spatial shift of image intensities on the image grid.
Definition: itkCyclicShiftImageFilter.h:46
itk::ImageToImageFilter::InputImageRegionType
typename InputImageType::RegionType InputImageRegionType
Definition: itkImageToImageFilter.h:132
itk::ImageToImageFilter::InputImageConstPointer
typename InputImageType::ConstPointer InputImageConstPointer
Definition: itkImageToImageFilter.h:131
itk::ImageSource::OutputImageType
TOutputImage OutputImageType
Definition: itkImageSource.h:90