SimpleITK  
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 sitkDualImageFilterTemplate.h.in to make changes.
25  */
26 
27 #include <memory>
28 
29 #include "sitkImageFilter.h"
31 #include "sitkBasicFilters.h"
32 
33 namespace itk::simple {
34 
43  public:
45 
47  virtual ~ShiftScaleImageFilter();
48 
52 
55 
56 \
57 
61  SITK_RETURN_SELF_TYPE_HEADER SetShift ( double Shift ) { this->m_Shift = Shift; return *this; }
62 
66  double GetShift() const { return this->m_Shift; }\
67 
71  SITK_RETURN_SELF_TYPE_HEADER SetScale ( double Scale ) { this->m_Scale = Scale; return *this; }
72 
76  double GetScale() const { return this->m_Scale; }\
77 
81  SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
82 
86  PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }
93  int64_t GetUnderflowCount() const { return this->m_UnderflowCount; };
94 
101  int64_t GetOverflowCount() const { return this->m_OverflowCount; };
102 
103 
105  std::string GetName() const { return std::string ("ShiftScaleImageFilter"); }
106 
108  std::string ToString() const;
109 
110 
113  Image Execute ( const Image& image1 );
114 
115 
116  private:
118  using MemberFunctionType = Image (Self::*)( const Image& image1 );
119 
121  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image& image1 );
123  template <class TImageType1, class TImageType2> Image DualExecuteInternalVector ( const Image& image1 );
124 
125  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
126 
127 
128 
129  double m_Shift{0};
130 
131  double m_Scale{1.0};
132 
134 
135  /* Some global documentation */
136  int64_t m_UnderflowCount{0u};
137  /* Some global documentation */
138  int64_t m_OverflowCount{0u};
139 
140 
141  };
142 
153  SITKBasicFilters_EXPORT Image ShiftScale ( const Image& image1, double shift = 0, double scale = 1.0, PixelIDValueEnum outputPixelType = itk::simple::sitkUnknown );
154 
156 }
157 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::ShiftScale
Image ShiftScale(const Image &image1, double shift=0, double scale=1.0, PixelIDValueEnum outputPixelType=itk::simple::sitkUnknown)
Shift and scale the pixels in an image.
itk::simple::BasicPixelIDTypeList
typelist2::typelist< BasicPixelID< int8_t >, BasicPixelID< uint8_t >, BasicPixelID< int16_t >, BasicPixelID< uint16_t >, BasicPixelID< int32_t >, BasicPixelID< uint32_t >, BasicPixelID< float >, BasicPixelID< double > > BasicPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:51
itk::simple::ShiftScaleImageFilter::m_DualMemberFactory
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkShiftScaleImageFilter.h:125
itk::simple::ShiftScaleImageFilter::GetShift
double GetShift() const
Definition: sitkShiftScaleImageFilter.h:66
itk::simple::ShiftScaleImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkShiftScaleImageFilter.h:118
itk::simple::ShiftScaleImageFilter::GetOutputPixelType
PixelIDValueEnum GetOutputPixelType() const
Get the output pixel type.
Definition: sitkShiftScaleImageFilter.h:86
itk::simple::PixelIDValueEnum
PixelIDValueEnum
Enumerated values of pixelIDs.
Definition: sitkPixelIDValues.h:91
sitkImageFilter.h
itk::simple::ShiftScaleImageFilter::GetUnderflowCount
int64_t GetUnderflowCount() const
Definition: sitkShiftScaleImageFilter.h:93
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:105
itk::simple::detail::DualExecuteInternalVectorAddressor
Definition: sitkDetail.h:78
sitkDualMemberFunctionFactory.h
itk::simple::ShiftScaleImageFilter::SetScale
Self & SetScale(double Scale)
Definition: sitkShiftScaleImageFilter.h:71
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:40
itk::simple::ShiftScaleImageFilter::SetOutputPixelType
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Set the output pixel type, if sitkUnknown then the input type is used.
Definition: sitkShiftScaleImageFilter.h:81
itk::simple::ShiftScaleImageFilter::GetScale
double GetScale() const
Definition: sitkShiftScaleImageFilter.h:76
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:34
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::sitkUnknown
@ sitkUnknown
Definition: sitkPixelIDValues.h:92
itk::simple::ShiftScaleImageFilter::SetShift
Self & SetShift(double Shift)
Definition: sitkShiftScaleImageFilter.h:61
itk::simple::ShiftScaleImageFilter::GetOverflowCount
int64_t GetOverflowCount() const
Definition: sitkShiftScaleImageFilter.h:101