File: itkSigmoidImageFilter.h

package info (click to toggle)
insighttoolkit 3.6.0-3
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 94,956 kB
  • ctags: 74,981
  • sloc: cpp: 355,621; ansic: 195,070; fortran: 28,713; python: 3,802; tcl: 1,996; sh: 1,175; java: 583; makefile: 415; csh: 184; perl: 175
file content (205 lines) | stat: -rw-r--r-- 5,567 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSigmoidImageFilter.h,v $
  Language:  C++
  Date:      $Date: 2007-09-16 14:41:02 $
  Version:   $Revision: 1.14 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkSigmoidImageFilter_h
#define __itkSigmoidImageFilter_h

#include "itkUnaryFunctorImageFilter.h"

namespace itk
{
  
/** \class SigmoidImageFilter
 * \brief Computes the sigmoid function pixel-wise
 * 
 * A linear transformation is applied first on the argument of 
 * the sigmoid fuction. The resulting total transfrom is given by
 *
 * \f[
 * f(x) = (Max-Min) \cdot \frac{1}{\left(1+e^{-(\frac{ x - \beta }{\alpha}\right)}} + Min
 * \f]
 *
 * Every output pixel is equal to f(x). Where x is the intensity of the
 * homologous input pixel, and alpha and beta are user-provided constants.
 * 
 * \ingroup IntensityImageFilters  Multithreaded
 *
 */

namespace Function {  
template< class TInput, class TOutput>
class Sigmoid
{
public:
  Sigmoid() { 
    m_Alpha = 1.0; 
    m_Beta =  0.0; 
    m_OutputMinimum = NumericTraits< TOutput >::min();
    m_OutputMaximum = NumericTraits< TOutput >::max();
  }
  ~Sigmoid() {};
  bool operator!=( const Sigmoid & other ) const
  {
    if( m_Alpha != other.m_Alpha ||
        m_Beta != other.m_Beta ||
        m_OutputMaximum != other.m_OutputMaximum    ||
        m_OutputMinimum != other.m_OutputMinimum  )
      {
      return true;
      }
    return false;
  }
  bool operator==( const Sigmoid & other ) const
  {
    return !(*this != other);
  }

  inline TOutput operator()( const TInput & A )
  {
    const double x = ( static_cast<double>(A) - m_Beta ) / m_Alpha;
    const double e = 1.0 / ( 1.0 + vcl_exp(- x ) );
    const double v = 
      (m_OutputMaximum - m_OutputMinimum ) * e + m_OutputMinimum;
    return static_cast<TOutput>( v );
  }
  void SetAlpha( double alpha ) {
    m_Alpha = alpha;
  }
  void SetBeta( double beta ) {
    m_Beta = beta;
  }
  double GetAlpha() const {
    return m_Alpha;
  }
  double GetBeta() const {
    return m_Beta;
  }
  void SetOutputMinimum( TOutput min ) {
    m_OutputMinimum = min;
  }
  void SetOutputMaximum( TOutput max ) {
    m_OutputMaximum = max;
  }
  TOutput GetOutputMinimum() const {
    return m_OutputMinimum;
  }
  TOutput GetOutputMaximum() const {
    return m_OutputMaximum;
  }

private:
  double  m_Alpha;
  double  m_Beta;
  TOutput m_OutputMinimum;
  TOutput m_OutputMaximum;
}; 
}


template <class TInputImage, class TOutputImage>
class ITK_EXPORT SigmoidImageFilter :
    public
UnaryFunctorImageFilter<TInputImage,TOutputImage, 
                        Function::Sigmoid< 
  typename TInputImage::PixelType, 
  typename TOutputImage::PixelType>   >
{
public:
  /** Standard class typedefs. */
  typedef SigmoidImageFilter  Self;
  typedef UnaryFunctorImageFilter<TInputImage,TOutputImage, 
                                  Function::Sigmoid< typename TInputImage::PixelType, 
                                                     typename TOutputImage::PixelType> >  Superclass;
  typedef SmartPointer<Self>   Pointer;
  typedef SmartPointer<const Self>  ConstPointer;

  typedef typename TOutputImage::PixelType OutputPixelType;

  /** Method for creation through the object factory. */
  itkNewMacro(Self);
  
  /** Macro that provides the GetNameOfClass() method */
  itkTypeMacro( SigmoidImageFilter, UnaryFunctorImageFilter );

  void SetAlpha( double alpha )
  {
    if( alpha == this->GetFunctor().GetAlpha() ) 
      {
      return;
      }
    this->GetFunctor().SetAlpha( alpha );
    this->Modified();
  }

  void SetBeta( double beta )
  {
    if( beta == this->GetFunctor().GetBeta() ) 
      {
      return;
      }
    this->GetFunctor().SetBeta( beta );
    this->Modified();
  }

  void SetOutputMinimum( OutputPixelType min )
  {
    if( min == this->GetFunctor().GetOutputMinimum() ) 
      {
      return;
      }
    this->GetFunctor().SetOutputMinimum( min );
    this->Modified();
  }

  void SetOutputMaximum( OutputPixelType max )
  {
    if( max == this->GetFunctor().GetOutputMaximum() ) 
      {
      return;
      }
    this->GetFunctor().SetOutputMaximum( max );
    this->Modified();
  }

#ifdef ITK_USE_CONCEPT_CHECKING
  /** Begin concept checking */
  itkConceptMacro(InputConvertibleToDoubleCheck,
    (Concept::Convertible<typename TInputImage::PixelType, double>));
  itkConceptMacro(OutputAdditiveOperatorsCheck,
    (Concept::AdditiveOperators<OutputPixelType>));
  itkConceptMacro(DoubleConvertibleToOutputCheck,
    (Concept::Convertible<double, OutputPixelType>));
  itkConceptMacro(OutputTimesDoubleCheck,
    (Concept::MultiplyOperator<OutputPixelType, double>));
  itkConceptMacro(OutputDoubleAdditiveOperatorsCheck,
    (Concept::AdditiveOperators<OutputPixelType, OutputPixelType, double>));
  /** End concept checking */
#endif

protected:
  SigmoidImageFilter() {}
  virtual ~SigmoidImageFilter() {}

private:
  SigmoidImageFilter(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

};

} // end namespace itk


#endif