SimpleITK  2.0.0rc2.post17
sitkSigmoidImageFilter.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 sitkSigmoidImageFilter_h
19 #define sitkSigmoidImageFilter_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 
47  public:
49 
51  virtual ~SigmoidImageFilter();
52 
56 
59 \
60 
63  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
64 
67  double GetAlpha() const { return this->m_Alpha; }\
68 
71  SITK_RETURN_SELF_TYPE_HEADER SetBeta ( double Beta ) { this->m_Beta = Beta; return *this; }
72 
75  double GetBeta() const { return this->m_Beta; }\
76 
79  SITK_RETURN_SELF_TYPE_HEADER SetOutputMaximum ( double OutputMaximum ) { this->m_OutputMaximum = OutputMaximum; return *this; }
80 
83  double GetOutputMaximum() const { return this->m_OutputMaximum; }\
84 
87  SITK_RETURN_SELF_TYPE_HEADER SetOutputMinimum ( double OutputMinimum ) { this->m_OutputMinimum = OutputMinimum; return *this; }
88 
91  double GetOutputMinimum() const { return this->m_OutputMinimum; }
92 
94  std::string GetName() const { return std::string ("SigmoidImageFilter"); }
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  private:
107 
110  using MemberFunctionType = Image (Self::*)( const Image& image1 );
111  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
112 
113 
115 
116  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
117 
118 
119  /* Alpha */
120  double m_Alpha{1};
121 
122  /* Alpha */
123  double m_Beta{0};
124 
125  double m_OutputMaximum{255};
126 
127  double m_OutputMinimum{0};
128 
129 
130  bool m_InPlace{false};
131  };
132 
142 #ifndef SWIG
143  SITKBasicFilters_EXPORT Image Sigmoid ( Image&& image1, double alpha = 1, double beta = 0, double outputMaximum = 255, double outputMinimum = 0 );
144 #endif
145  SITKBasicFilters_EXPORT Image Sigmoid ( const Image& image1, double alpha = 1, double beta = 0, double outputMaximum = 255, double outputMinimum = 0 );
146 
148  }
149 }
150 #endif
itk::simple::SigmoidImageFilter::SetOutputMinimum
Self & SetOutputMinimum(double OutputMinimum)
Definition: sitkSigmoidImageFilter.h:87
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:75
itk::simple::Sigmoid
Image Sigmoid(Image &&image1, double alpha=1, double beta=0, double outputMaximum=255, double outputMinimum=0)
Computes the sigmoid function pixel-wise.
sitkBasicFilters.h
itk::simple::SigmoidImageFilter::GetName
std::string GetName() const
Definition: sitkSigmoidImageFilter.h:94
itk::simple::SigmoidImageFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkSigmoidImageFilter.h:63
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::SigmoidImageFilter
Computes the sigmoid function pixel-wise.
Definition: sitkSigmoidImageFilter.h:46
itk::simple::SigmoidImageFilter::SetOutputMaximum
Self & SetOutputMaximum(double OutputMaximum)
Definition: sitkSigmoidImageFilter.h:79
itk::simple::SigmoidImageFilter::GetOutputMinimum
double GetOutputMinimum() const
Definition: sitkSigmoidImageFilter.h:91
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::SigmoidImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkSigmoidImageFilter.h:116
itk::simple::SigmoidImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkSigmoidImageFilter.h:110
itk::simple::SigmoidImageFilter::GetAlpha
double GetAlpha() const
Definition: sitkSigmoidImageFilter.h:67
itk::simple::SigmoidImageFilter::GetBeta
double GetBeta() const
Definition: sitkSigmoidImageFilter.h:75
itk::simple::SigmoidImageFilter::GetOutputMaximum
double GetOutputMaximum() const
Definition: sitkSigmoidImageFilter.h:83
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk
itk::simple::SigmoidImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkSigmoidImageFilter.h:58
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::SigmoidImageFilter::SetBeta
Self & SetBeta(double Beta)
Definition: sitkSigmoidImageFilter.h:71