SimpleITK  2.0.0rc2.post21
sitkShiftScaleImageFilter.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 sitkShiftScaleImageFilter_h
19 #define sitkShiftScaleImageFilter_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 
43  public:
45 
47  virtual ~ShiftScaleImageFilter();
48 
52 
55 \
56 
60  SITK_RETURN_SELF_TYPE_HEADER SetShift ( double Shift ) { this->m_Shift = Shift; return *this; }
61 
65  double GetShift() const { return this->m_Shift; }\
66 
70  SITK_RETURN_SELF_TYPE_HEADER SetScale ( double Scale ) { this->m_Scale = Scale; return *this; }
71 
75  double GetScale() const { return this->m_Scale; }
82  int64_t GetUnderflowCount() const { return this->m_UnderflowCount; };
83 
90  int64_t GetOverflowCount() const { return this->m_OverflowCount; };
91 
92 
94  std::string GetName() const { return std::string ("ShiftScaleImageFilter"); }
95 
97  std::string ToString() const;
98 
99 
102  Image Execute ( const Image& image1 );
103 
104  private:
105 
108  using MemberFunctionType = Image (Self::*)( const Image& image1 );
109  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
111  template <class TImageType> Image ExecuteInternalVectorImage ( const Image& image );
112 
115  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
116 
117 
118  double m_Shift{0};
119 
120  double m_Scale{1.0};
121 
122  /* Some global documentation */
123  int64_t m_UnderflowCount{0u};
124  /* Some global documentation */
125  int64_t m_OverflowCount{0u};
126 
127 
128  };
129 
140  SITKBasicFilters_EXPORT Image ShiftScale ( const Image& image1, double shift = 0, double scale = 1.0 );
141 
143  }
144 }
145 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
sitkBasicFilters.h
itk::simple::ShiftScale
Image ShiftScale(const Image &image1, double shift=0, double scale=1.0)
Shift and scale the pixels in an image.
itk::simple::detail::ExecuteInternalVectorImageAddressor
Definition: sitkDetail.h:59
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::ShiftScaleImageFilter::GetShift
double GetShift() const
Definition: sitkShiftScaleImageFilter.h:65
itk::simple::ShiftScaleImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkShiftScaleImageFilter.h:108
itk::simple::BasicPixelIDTypeList
typelist::MakeTypeList< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > >::Type BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:53
sitkImageFilter.h
itk::simple::ShiftScaleImageFilter::GetUnderflowCount
int64_t GetUnderflowCount() const
Definition: sitkShiftScaleImageFilter.h:82
itk::int64_t
::int64_t int64_t
itk::simple::ShiftScaleImageFilter
Shift and scale the pixels in an image.
Definition: sitkShiftScaleImageFilter.h:42
itk::simple::ShiftScaleImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkShiftScaleImageFilter.h:54
itk::simple::ShiftScaleImageFilter::GetName
std::string GetName() const
Definition: sitkShiftScaleImageFilter.h:94
itk::simple::ShiftScaleImageFilter::SetScale
Self & SetScale(double Scale)
Definition: sitkShiftScaleImageFilter.h:70
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ShiftScaleImageFilter::GetScale
double GetScale() const
Definition: sitkShiftScaleImageFilter.h:75
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::simple::ShiftScaleImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkShiftScaleImageFilter.h:115
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::ShiftScaleImageFilter::SetShift
Self & SetShift(double Shift)
Definition: sitkShiftScaleImageFilter.h:60
itk::simple::ShiftScaleImageFilter::GetOverflowCount
int64_t GetOverflowCount() const
Definition: sitkShiftScaleImageFilter.h:90