SimpleITK  
sitkCyclicShiftImageFilter.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 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::simple {
33 
44  public:
46 
48  virtual ~CyclicShiftImageFilter();
49 
53 
56 \
57 
61  SITK_RETURN_SELF_TYPE_HEADER SetShift ( std::vector<int> Shift ) { this->m_Shift = std::move(Shift); return *this; }
62 
64  SITK_RETURN_SELF_TYPE_HEADER SetShift( int value ) { this->m_Shift = std::vector<int>(3, value); return *this; }
65 
69  std::vector<int> GetShift() const { return this->m_Shift; }
70 
72  std::string GetName() const { return std::string ("CyclicShiftImageFilter"); }
73 
75  std::string ToString() const;
76 
77 
80  Image Execute ( const Image& image1 );
81 
82  private:
83 
86  using MemberFunctionType = Image (Self::*)( const Image& image1 );
87  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
88 
89 
91 
92  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
93 
94 
95  std::vector<int> m_Shift{std::vector<int>(3, 0)};
96 
97 
98  };
99 
110  SITKBasicFilters_EXPORT Image CyclicShift ( const Image& image1, std::vector<int> shift = std::vector<int>(3, 0) );
111 
113 }
114 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:29
itk::simple::CyclicShiftImageFilter::SetShift
Self & SetShift(int value)
Definition: sitkCyclicShiftImageFilter.h:64
itk::simple::CyclicShiftImageFilter::GetName
std::string GetName() const
Definition: sitkCyclicShiftImageFilter.h:72
itk::simple::CyclicShiftImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkCyclicShiftImageFilter.h:92
itk::simple::CyclicShiftImageFilter
Perform a cyclic spatial shift of image intensities on the image grid.
Definition: sitkCyclicShiftImageFilter.h:43
sitkImageFilter.h
itk::simple::CyclicShiftImageFilter::PixelIDTypeList
NonLabelPixelIDTypeList PixelIDTypeList
Definition: sitkCyclicShiftImageFilter.h:55
itk::simple::CyclicShiftImageFilter::SetShift
Self & SetShift(std::vector< int > Shift)
Definition: sitkCyclicShiftImageFilter.h:61
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::NonLabelPixelIDTypeList
typelist2::append< BasicPixelIDTypeList, ComplexPixelIDTypeList, VectorPixelIDTypeList >::type NonLabelPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:180
itk::simple::CyclicShift
Image CyclicShift(const Image &image1, std::vector< int > shift=std::vector< int >(3, 0))
Perform a cyclic spatial shift of image intensities on the image grid.
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::simple::CyclicShiftImageFilter::GetShift
std::vector< int > GetShift() const
Definition: sitkCyclicShiftImageFilter.h:69
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple::CyclicShiftImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkCyclicShiftImageFilter.h:86
itk::simple
Definition: sitkAdditionalProcedures.h:28