SimpleITK  
sitkUnsharpMaskImageFilter.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 sitkUnsharpMaskImageFilter_h
19 #define sitkUnsharpMaskImageFilter_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 
56  public:
58 
60  virtual ~UnsharpMaskImageFilter();
61 
65 
69  SITK_RETURN_SELF_TYPE_HEADER SetSigmas(double s) { this->m_Sigmas = std::vector<double>(3, s ); return *this; }
70 
71 \
72 
76  SITK_RETURN_SELF_TYPE_HEADER SetSigmas ( std::vector<double> Sigmas ) { this->m_Sigmas = std::move(Sigmas); return *this; }
77 
81  std::vector<double> GetSigmas() const { return this->m_Sigmas; }\
82 
86  SITK_RETURN_SELF_TYPE_HEADER SetAmount ( double Amount ) { this->m_Amount = Amount; return *this; }
87 
91  double GetAmount() const { return this->m_Amount; }\
92 
96  SITK_RETURN_SELF_TYPE_HEADER SetThreshold ( double Threshold ) { this->m_Threshold = Threshold; return *this; }
97 
101  double GetThreshold() const { return this->m_Threshold; }\
102 
106  SITK_RETURN_SELF_TYPE_HEADER SetClamp ( bool Clamp ) { this->m_Clamp = Clamp; return *this; }
107 
109  SITK_RETURN_SELF_TYPE_HEADER ClampOn() { return this->SetClamp(true); }
110  SITK_RETURN_SELF_TYPE_HEADER ClampOff() { return this->SetClamp(false); }
111 
114  bool GetClamp() const { return this->m_Clamp; }
115 
117  std::string GetName() const { return std::string ("UnsharpMaskImageFilter"); }
118 
120  std::string ToString() const;
121 
122 
125  Image Execute ( const Image& image1 );
126 
127  private:
128 
131  using MemberFunctionType = Image (Self::*)( const Image& image1 );
132  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
133 
134 
136 
137  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
138 
139 
140  std::vector<double> m_Sigmas{std::vector<double>(3, 1.0)};
141 
142  double m_Amount{0.5};
143 
144  double m_Threshold{0.0};
145 
146  bool m_Clamp{true};
147 
148 
149  };
150 
161  SITKBasicFilters_EXPORT Image UnsharpMask ( const Image& image1, std::vector<double> sigmas = std::vector<double>(3, 1.0), double amount = 0.5, double threshold = 0.0, bool clamp = true );
162 
164 }
165 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
sitkBasicFilters.h
itk::simple::UnsharpMaskImageFilter::ClampOff
Self & ClampOff()
Definition: sitkUnsharpMaskImageFilter.h:110
itk::simple::UnsharpMaskImageFilter
Edge enhancement filter.
Definition: sitkUnsharpMaskImageFilter.h:55
itk::simple::UnsharpMaskImageFilter::GetSigmas
std::vector< double > GetSigmas() const
Definition: sitkUnsharpMaskImageFilter.h:81
itk::simple::UnsharpMaskImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkUnsharpMaskImageFilter.h:137
itk::simple::RealPixelIDTypeList
typelist2::typelist< BasicPixelID< float >, BasicPixelID< double > > RealPixelIDTypeList
Definition: sitkPixelIDTypeLists.h:98
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::UnsharpMaskImageFilter::ClampOn
Self & ClampOn()
Definition: sitkUnsharpMaskImageFilter.h:109
itk::simple::UnsharpMaskImageFilter::GetClamp
bool GetClamp() const
Definition: sitkUnsharpMaskImageFilter.h:114
itk::simple::UnsharpMaskImageFilter::PixelIDTypeList
RealPixelIDTypeList PixelIDTypeList
Definition: sitkUnsharpMaskImageFilter.h:67
itk::simple::UnsharpMaskImageFilter::GetThreshold
double GetThreshold() const
Definition: sitkUnsharpMaskImageFilter.h:101
sitkImageFilter.h
itk::simple::UnsharpMaskImageFilter::GetAmount
double GetAmount() const
Definition: sitkUnsharpMaskImageFilter.h:91
itk::simple::UnsharpMaskImageFilter::GetName
std::string GetName() const
Definition: sitkUnsharpMaskImageFilter.h:117
itk::simple::UnsharpMaskImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkUnsharpMaskImageFilter.h:131
itk::simple::UnsharpMaskImageFilter::SetClamp
Self & SetClamp(bool Clamp)
Set/Get whether to clamp values to supported range of output type.
Definition: sitkUnsharpMaskImageFilter.h:106
itk::simple::UnsharpMaskImageFilter::SetAmount
Self & SetAmount(double Amount)
Definition: sitkUnsharpMaskImageFilter.h:86
itk::simple::UnsharpMaskImageFilter::SetThreshold
Self & SetThreshold(double Threshold)
Definition: sitkUnsharpMaskImageFilter.h:96
itk::simple::UnsharpMaskImageFilter::SetSigmas
Self & SetSigmas(std::vector< double > Sigmas)
Definition: sitkUnsharpMaskImageFilter.h:76
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::Threshold
Image Threshold(Image &&image1, double lower=0.0, double upper=1.0, double outsideValue=0.0)
Set image values to a user-specified value if they are below, above, or between simple threshold valu...
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::UnsharpMask
Image UnsharpMask(const Image &image1, std::vector< double > sigmas=std::vector< double >(3, 1.0), double amount=0.5, double threshold=0.0, bool clamp=true)
Edge enhancement filter.
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::UnsharpMaskImageFilter::SetSigmas
Self & SetSigmas(double s)
Definition: sitkUnsharpMaskImageFilter.h:69