ITK  4.13.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:
55 
57  typedef TInputImage InputImageType;
58  typedef TOutputImage OutputImageType;
59  typedef typename InputImageType::Pointer InputImagePointer;
60  typedef typename InputImageType::ConstPointer InputImageConstPointer;
61  typedef typename InputImageType::RegionType InputImageRegionType;
62  typedef typename InputImageType::PixelType InputImagePixelType;
63  typedef typename OutputImageType::Pointer OutputImagePointer;
64  typedef typename OutputImageType::ConstPointer OutputImageConstPointer;
65  typedef typename OutputImageType::RegionType OutputImageRegionType;
66  typedef typename OutputImageType::PixelType OutputImagePixelType;
69  typedef typename OutputImageType::OffsetType OffsetType;
71 
73  itkStaticConstMacro(ImageDimension, unsigned int,
74  TInputImage::ImageDimension);
75 
77  itkNewMacro(Self);
78 
81 
83  itkSetMacro(Shift, OffsetType);
84  itkGetConstMacro(Shift, OffsetType);
86 
87 protected:
89  ~CyclicShiftImageFilter() ITK_OVERRIDE {}
90  void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
91 
94  void GenerateInputRequestedRegion() ITK_OVERRIDE;
95 
97  void ThreadedGenerateData(const OutputImageRegionType &
98  outputRegionForThread,
99  ThreadIdType threadId) ITK_OVERRIDE;
100 
103  OffsetType m_Shift;
104 
105 private:
106  ITK_DISALLOW_COPY_AND_ASSIGN(CyclicShiftImageFilter);
107 
108 }; // end of class
109 } // end namespace itk
110 
111 #ifndef ITK_MANUAL_INSTANTIATION
112 #include "itkCyclicShiftImageFilter.hxx"
113 #endif
114 
115 
116 #endif
OutputImageType::SizeType SizeType
OutputImageType::ConstPointer OutputImageConstPointer
InputImageType::Pointer InputImagePointer
OutputImageType::PixelType OutputImagePixelType
InputImageType::RegionType InputImageRegionType
signed long OffsetValueType
Definition: itkIntTypes.h:154
OutputImageType::IndexType IndexType
Base class for all process objects that output image data.
OutputImageType::Pointer OutputImagePointer
OutputImageType::OffsetType OffsetType
SmartPointer< const Self > ConstPointer
InputImageType::ConstPointer InputImageConstPointer
unsigned int ThreadIdType
Definition: itkIntTypes.h:159
InputImageType::PixelType InputImagePixelType
Base class for filters that take an image as input and produce an image as output.
ImageToImageFilter< TInputImage, TOutputImage > Superclass
Control indentation during Print() invocation.
Definition: itkIndent.h:49
OutputImageType::OffsetValueType OffsetValueType
Perform a cyclic spatial shift of image intensities on the image grid.
OutputImageType::RegionType OutputImageRegionType