SimpleITK  1.1.0
sitkCyclicShiftImageFilter.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 sitkCyclicShiftImageFilter_h
19 #define sitkCyclicShiftImageFilter_h
20 
21 /*
22  * WARNING: DO NOT EDIT THIS FILE!
23  * THIS FILE IS AUTOMATICALLY GENERATED BY THE SIMPLEITK BUILD PROCESS.
24  * Please look at sitkImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkBasicFilters.h"
30 #include "sitkImageFilter.h"
31 
32 namespace itk {
33  namespace simple {
34 
45  public:
47 
49  virtual ~CyclicShiftImageFilter();
50 
54 
57 
58 
59 
63  SITK_RETURN_SELF_TYPE_HEADER SetShift ( const std::vector<int> & Shift ) { this->m_Shift = Shift; return *this; }
64 
66  SITK_RETURN_SELF_TYPE_HEADER SetShift( int value ) { this->m_Shift = std::vector<int>(3, value); return *this; }
67 
68 
72  std::vector<int> GetShift() const { return this->m_Shift; }
74  std::string GetName() const { return std::string ("CyclicShiftImageFilter"); }
75 
77  std::string ToString() const;
78 
79 
81  Image Execute ( const Image& image1 );
82 
83 
85  Image Execute ( const Image& image1, const std::vector<int> & shift );
86 
87  private:
88 
91  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
92  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
93 
94 
95  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
96 
97  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
98 
99 
100  std::vector<int> m_Shift;
101  };
102 
103 
112  SITKBasicFilters_EXPORT Image CyclicShift ( const Image& image1, const std::vector<int> & shift = std::vector<int>(3, 0) );
113 
114  }
115 }
116 #endif
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::CyclicShiftImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkCyclicShiftImageFilter.h:56
itk::simple::CyclicShiftImageFilter::SetShift
Self & SetShift(int value)
Definition: sitkCyclicShiftImageFilter.h:66
itk::simple::CyclicShiftImageFilter::GetName
std::string GetName() const
Definition: sitkCyclicShiftImageFilter.h:74
itk::simple::CyclicShift
Image CyclicShift(const Image &image1, const std::vector< int > &shift=std::vector< int >(3, 0))
Perform a cyclic spatial shift of image intensities on the image grid.
itk::simple::NonLabelPixelIDTypeList
typelist::Append< typelist::Append< BasicPixelIDTypeList, ComplexPixelIDTypeList >::Type, VectorPixelIDTypeList >::Type NonLabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:180
itk::simple::CyclicShiftImageFilter::Self
CyclicShiftImageFilter Self
Definition: sitkCyclicShiftImageFilter.h:46
itk::simple::CyclicShiftImageFilter
Perform a cyclic spatial shift of image intensities on the image grid.
Definition: sitkCyclicShiftImageFilter.h:44
sitkImageFilter.h
itk::simple::CyclicShiftImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCyclicShiftImageFilter.h:97
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk
itk::simple::CyclicShiftImageFilter::m_Shift
std::vector< int > m_Shift
Definition: sitkCyclicShiftImageFilter.h:100
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::CyclicShiftImageFilter::GetShift
std::vector< int > GetShift() const
Definition: sitkCyclicShiftImageFilter.h:72
itk::simple::CyclicShiftImageFilter::SetShift
Self & SetShift(const std::vector< int > &Shift)
Definition: sitkCyclicShiftImageFilter.h:63