SimpleITK  
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::simple {
34 
53  public:
55 
57  virtual ~ClampImageFilter();
58 
62 
65 
66 \
67 
70  SITK_RETURN_SELF_TYPE_HEADER SetOutputPixelType ( PixelIDValueEnum OutputPixelType ) { this->m_OutputPixelType = OutputPixelType; return *this; }
71 
74  PixelIDValueEnum GetOutputPixelType() const { return this->m_OutputPixelType; }\
75 
78  SITK_RETURN_SELF_TYPE_HEADER SetLowerBound ( double LowerBound ) { this->m_LowerBound = LowerBound; return *this; }
79 
82  double GetLowerBound() const { return this->m_LowerBound; }\
83 
86  SITK_RETURN_SELF_TYPE_HEADER SetUpperBound ( double UpperBound ) { this->m_UpperBound = UpperBound; return *this; }
87 
90  double GetUpperBound() const { return this->m_UpperBound; }
91 
93  std::string GetName() const { return std::string ("ClampImageFilter"); }
94 
96  std::string ToString() const;
97 
98 
100 #ifndef SWIG
101  Image Execute ( Image&& image1 );
102 #endif
103  Image Execute ( const Image& image1 );
104 
105 
106  private:
108  using MemberFunctionType = Image (Self::*)( const Image& image1 );
109 
111  template <class TImageType1, class TImageType2> Image DualExecuteInternal ( const Image& image1 );
113  template <class TImageType1, class TImageType2> Image DualExecuteInternalVector ( const Image& image1 );
114 
115  std::unique_ptr<detail::DualMemberFunctionFactory<MemberFunctionType> > m_DualMemberFactory;
116 
117 
118 
120 
121  double m_LowerBound{-std::numeric_limits<double>::max()};
122 
123  double m_UpperBound{std::numeric_limits<double>::max()};
124 
125 
126  bool m_InPlace{false};
127  };
128 
138 #ifndef SWIG
139  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() );
140 #endif
141  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() );
142 
144 }
145 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::ClampImageFilter::GetOutputPixelType
PixelIDValueEnum GetOutputPixelType() const
Definition: sitkClampImageFilter.h:74
sitkBasicFilters.h
itk::simple::ClampImageFilter::m_DualMemberFactory
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > m_DualMemberFactory
Definition: sitkClampImageFilter.h:115
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::ClampImageFilter::GetLowerBound
double GetLowerBound() const
Definition: sitkClampImageFilter.h:82
itk::simple::PixelIDValueEnum
PixelIDValueEnum
Enumerated values of pixelIDs.
Definition: sitkPixelIDValues.h:100
sitkImageFilter.h
itk::simple::ClampImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkClampImageFilter.h:108
itk::simple::detail::DualExecuteInternalVectorAddressor
Definition: sitkDetail.h:83
itk::simple::ClampImageFilter::SetOutputPixelType
Self & SetOutputPixelType(PixelIDValueEnum OutputPixelType)
Definition: sitkClampImageFilter.h:70
itk::simple::ClampImageFilter
Casts input pixels to output pixel type and clamps the output pixel values to a specified range.
Definition: sitkClampImageFilter.h:52
itk::simple::ClampImageFilter::SetLowerBound
Self & SetLowerBound(double LowerBound)
Definition: sitkClampImageFilter.h:78
sitkDualMemberFunctionFactory.h
itk::simple::ClampImageFilter::SetUpperBound
Self & SetUpperBound(double UpperBound)
Definition: sitkClampImageFilter.h:86
itk::simple::ClampImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkClampImageFilter.h:64
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::ClampImageFilter::GetName
std::string GetName() const
Definition: sitkClampImageFilter.h:93
itk::simple::detail::DualExecuteInternalAddressor
Definition: sitkDetail.h:42
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:35
itk::Image
Definition: sitkPixelIDTypes.h:28
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::sitkUnknown
@ sitkUnknown
Definition: sitkPixelIDValues.h:102
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:90