SimpleITK  
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::simple {
33 
46  public:
48 
50  virtual ~SigmoidImageFilter();
51 
55 
58 \
59 
62  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
63 
66  double GetAlpha() const { return this->m_Alpha; }\
67 
70  SITK_RETURN_SELF_TYPE_HEADER SetBeta ( double Beta ) { this->m_Beta = Beta; return *this; }
71 
74  double GetBeta() const { return this->m_Beta; }\
75 
78  SITK_RETURN_SELF_TYPE_HEADER SetOutputMaximum ( double OutputMaximum ) { this->m_OutputMaximum = OutputMaximum; return *this; }
79 
82  double GetOutputMaximum() const { return this->m_OutputMaximum; }\
83 
86  SITK_RETURN_SELF_TYPE_HEADER SetOutputMinimum ( double OutputMinimum ) { this->m_OutputMinimum = OutputMinimum; return *this; }
87 
90  double GetOutputMinimum() const { return this->m_OutputMinimum; }
91 
93  std::string GetName() const { return std::string ("SigmoidImageFilter"); }
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  private:
106 
109  using MemberFunctionType = Image (Self::*)( const Image& image1 );
110  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
111 
112 
114 
115  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
116 
117 
118  /* Alpha */
119  double m_Alpha{1};
120 
121  /* Alpha */
122  double m_Beta{0};
123 
124  double m_OutputMaximum{255};
125 
126  double m_OutputMinimum{0};
127 
128 
129  bool m_InPlace{false};
130  };
131 
141 #ifndef SWIG
142  SITKBasicFilters_EXPORT Image Sigmoid ( Image&& image1, double alpha = 1, double beta = 0, double outputMaximum = 255, double outputMinimum = 0 );
143 #endif
144  SITKBasicFilters_EXPORT Image Sigmoid ( const Image& image1, double alpha = 1, double beta = 0, double outputMaximum = 255, double outputMinimum = 0 );
145 
147 }
148 #endif
itk::simple::SigmoidImageFilter::SetOutputMinimum
Self & SetOutputMinimum(double OutputMinimum)
Definition: sitkSigmoidImageFilter.h:86
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
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:93
itk::simple::SigmoidImageFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkSigmoidImageFilter.h:62
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::SigmoidImageFilter
Computes the sigmoid function pixel-wise.
Definition: sitkSigmoidImageFilter.h:45
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::SigmoidImageFilter::SetOutputMaximum
Self & SetOutputMaximum(double OutputMaximum)
Definition: sitkSigmoidImageFilter.h:78
itk::simple::SigmoidImageFilter::GetOutputMinimum
double GetOutputMinimum() const
Definition: sitkSigmoidImageFilter.h:90
sitkImageFilter.h
itk::simple::SigmoidImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkSigmoidImageFilter.h:115
itk::simple::SigmoidImageFilter::MemberFunctionType
Image(Self::*)(const Image &image1) MemberFunctionType
Definition: sitkSigmoidImageFilter.h:109
itk::simple::SigmoidImageFilter::GetAlpha
double GetAlpha() const
Definition: sitkSigmoidImageFilter.h:66
itk::simple::SigmoidImageFilter::GetBeta
double GetBeta() const
Definition: sitkSigmoidImageFilter.h:74
itk::simple::SigmoidImageFilter::GetOutputMaximum
double GetOutputMaximum() const
Definition: sitkSigmoidImageFilter.h:82
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::SigmoidImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkSigmoidImageFilter.h:57
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::SigmoidImageFilter::SetBeta
Self & SetBeta(double Beta)
Definition: sitkSigmoidImageFilter.h:70