SimpleITK  2.0.0rc2.post23
sitkClampImageFilter.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 sitkClampImageFilter_h
19 #define sitkClampImageFilter_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 {
34  namespace simple {
35 
54  public:
56 
58  virtual ~ClampImageFilter();
59 
63 
66 
67 \
68 
71  SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
72 
75  PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }\
76 
79  SITK_RETURN_SELF_TYPE_HEADER SetLowerBound ( double LowerBound ) { this->m_LowerBound = LowerBound; return *this; }
80 
83  double GetLowerBound() const { return this->m_LowerBound; }\
84 
87  SITK_RETURN_SELF_TYPE_HEADER SetUpperBound ( double UpperBound ) { this->m_UpperBound = UpperBound; return *this; }
88 
91  double GetUpperBound() const { return this->m_UpperBound; }
92 
94  std::string GetName() const { return std::string ("ClampImageFilter"); }
95 
97  std::string ToString() const;
98 
99 
101 #ifndef SWIG
102  Image Execute ( Image&& image1 );
103 #endif
104  Image Execute ( const Image& image1 );
105 
106 
107  private:
109  using MemberFunctionType = Image (Self::*)( const Image& image1 );
110 
112  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image& image1 );
114  template <class TImageType1, class TImageType2> Image DualExecuteInternalVector ( const Image& image1 );
115 
116  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
117 
118 
119 
121 
122  double m_LowerBound{-std::numeric_limits<double>::max()};
123 
124  double m_UpperBound{std::numeric_limits<double>::max()};
125 
126 
127  bool m_InPlace{false};
128  };
129 
139 #ifndef SWIG
140  SITKBasicFilters_EXPORT Image Clamp ( Image&& image1, PixelIDValueEnum outputPixelType = itk::simple::sitkUnknown, double lowerBound = -std::numeric_limits<double>::max(), double upperBound = std::numeric_limits<double>::max() );
141 #endif
142  SITKBasicFilters_EXPORT Image Clamp ( const Image& image1, PixelIDValueEnum outputPixelType = itk::simple::sitkUnknown, double lowerBound = -std::numeric_limits<double>::max(), double upperBound = std::numeric_limits<double>::max() );
143 
145  }
146 }
147 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::ClampImageFilter::GetOutputPixelType
PixelIDValueEnum GetOutputPixelType() const
Definition: sitkClampImageFilter.h:75
sitkBasicFilters.h
itk::simple::ClampImageFilter::m_DualMemberFactory
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkClampImageFilter.h:116
itk::simple::ClampImageFilter::GetLowerBound
double GetLowerBound() const
Definition: sitkClampImageFilter.h:83
itk::simple::PixelIDValueEnum
PixelIDValueEnum
Enumerated values of pixelIDs.
Definition: sitkPixelIDValues.h:90
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::ClampImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkClampImageFilter.h:109
itk::simple::detail::DualExecuteInternalVectorAddressor
Definition: sitkDetail.h:75
itk::simple::ClampImageFilter::SetOutputPixelType
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Definition: sitkClampImageFilter.h:71
itk::simple::ClampImageFilter
Casts input pixels to output pixel type and clamps the output pixel values to a specified range.
Definition: sitkClampImageFilter.h:53
itk::simple::ClampImageFilter::SetLowerBound
Self & SetLowerBound(double LowerBound)
Definition: sitkClampImageFilter.h:79
sitkDualMemberFunctionFactory.h
itk::simple::ClampImageFilter::SetUpperBound
Self & SetUpperBound(double UpperBound)
Definition: sitkClampImageFilter.h:87
itk::simple::ClampImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkClampImageFilter.h:65
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ClampImageFilter::GetName
std::string GetName() const
Definition: sitkClampImageFilter.h:94
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:44
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:36
itk::Image
Definition: sitkPixelIDTypes.h:26
itk::simple::sitkUnknown
@ sitkUnknown
Definition: sitkPixelIDValues.h:91
itk::simple::Clamp
Image Clamp(Image &&image1, PixelIDValueEnum outputPixelType=itk::simple::sitkUnknown, double lowerBound=-std::numeric_limits< double >::max(), double upperBound=std::numeric_limits< double >::max())
Casts input pixels to output pixel type and clamps the output pixel values to a specified range.
itk::simple::ClampImageFilter::GetUpperBound
double GetUpperBound() const
Definition: sitkClampImageFilter.h:91