SimpleITK  1.1.0
sitkSigmoidImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright Insight Software Consortium
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 
53  public:
55 
57  virtual ~SigmoidImageFilter();
58 
62 
65 
66 
67 
70  SITK_RETURN_SELF_TYPE_HEADER SetAlpha ( double Alpha ) { this->m_Alpha = Alpha; return *this; }
71 
74  double GetAlpha() const { return this->m_Alpha; }
75 
78  SITK_RETURN_SELF_TYPE_HEADER SetBeta ( double Beta ) { this->m_Beta = Beta; return *this; }
79 
82  double GetBeta() const { return this->m_Beta; }
83 
86  SITK_RETURN_SELF_TYPE_HEADER SetOutputMaximum ( double OutputMaximum ) { this->m_OutputMaximum = OutputMaximum; return *this; }
87 
90  double GetOutputMaximum() const { return this->m_OutputMaximum; }
91 
94  SITK_RETURN_SELF_TYPE_HEADER SetOutputMinimum ( double OutputMinimum ) { this->m_OutputMinimum = OutputMinimum; return *this; }
95 
98  double GetOutputMinimum() const { return this->m_OutputMinimum; }
100  std::string GetName() const { return std::string ("SigmoidImageFilter"); }
101 
103  std::string ToString() const;
104 
105 
107  Image Execute ( const Image& image1 );
108 
109 
111  Image Execute ( const Image& image1, double alpha, double beta, double outputMaximum, double outputMinimum );
112 
113  private:
114 
117  typedef Image (Self::*MemberFunctionType)( const Image& image1 );
118  template <class TImageType> Image ExecuteInternal ( const Image& image1 );
119 
120 
121  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
122 
123  nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
124 
125 
126  /* Alpha */
127  double m_Alpha;
128  /* Alpha */
129  double m_Beta;
132  };
133 
134 
143  SITKBasicFilters_EXPORT Image Sigmoid ( const Image& image1, double alpha = 1, double beta = 0, double outputMaximum = 255, double outputMinimum = 0 );
144 
145  }
146 }
147 #endif
itk::simple::SigmoidImageFilter::SetOutputMinimum
Self & SetOutputMinimum(double OutputMinimum)
Definition: sitkSigmoidImageFilter.h:94
itk::simple::Image
The main Image class for SimpleITK.
Definition: sitkImage.h:54
itk::simple::SigmoidImageFilter::m_Alpha
double m_Alpha
Definition: sitkSigmoidImageFilter.h:127
sitkBasicFilters.h
itk::simple::SigmoidImageFilter::GetName
std::string GetName() const
Definition: sitkSigmoidImageFilter.h:100
itk::simple::SigmoidImageFilter::SetAlpha
Self & SetAlpha(double Alpha)
Definition: sitkSigmoidImageFilter.h:70
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:32
itk::simple::SigmoidImageFilter
Computes the sigmoid function pixel-wise.
Definition: sitkSigmoidImageFilter.h:52
itk::simple::SigmoidImageFilter::PixelIDTypeList
BasicPixelIDTypeList PixelIDTypeList
Definition: sitkSigmoidImageFilter.h:64
itk::simple::SigmoidImageFilter::SetOutputMaximum
Self & SetOutputMaximum(double OutputMaximum)
Definition: sitkSigmoidImageFilter.h:86
itk::simple::SigmoidImageFilter::GetOutputMinimum
double GetOutputMinimum() const
Definition: sitkSigmoidImageFilter.h:98
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::GetAlpha
double GetAlpha() const
Definition: sitkSigmoidImageFilter.h:74
itk::simple::SigmoidImageFilter::m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkSigmoidImageFilter.h:123
itk::simple::SigmoidImageFilter::m_OutputMaximum
double m_OutputMaximum
Definition: sitkSigmoidImageFilter.h:130
itk::simple::SigmoidImageFilter::GetBeta
double GetBeta() const
Definition: sitkSigmoidImageFilter.h:82
itk::simple::SigmoidImageFilter::GetOutputMaximum
double GetOutputMaximum() const
Definition: sitkSigmoidImageFilter.h:90
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:50
itk::simple::SigmoidImageFilter::Self
SigmoidImageFilter Self
Definition: sitkSigmoidImageFilter.h:54
itk::simple::SigmoidImageFilter::m_OutputMinimum
double m_OutputMinimum
Definition: sitkSigmoidImageFilter.h:131
itk::simple::SigmoidImageFilter::m_Beta
double m_Beta
Definition: sitkSigmoidImageFilter.h:129
itk
itk::simple::ImageFilter
The base interface for SimpleITK filters that take one input image.
Definition: sitkImageFilter.h:37
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:50
itk::simple::Sigmoid
Image Sigmoid(const Image &image1, double alpha=1, double beta=0, double outputMaximum=255, double outputMinimum=0)
Computes the sigmoid function pixel-wise.
itk::simple::SigmoidImageFilter::SetBeta
Self & SetBeta(double Beta)
Definition: sitkSigmoidImageFilter.h:78