SimpleITK  2.2.0.dev7
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::SigmoidImageFilter Class Reference

Computes the sigmoid function pixel-wise. More...

#include <sitkSigmoidImageFilter.h>

+ Inheritance diagram for itk::simple::SigmoidImageFilter:
+ Collaboration diagram for itk::simple::SigmoidImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
using Self = SigmoidImageFilter
- Public Types inherited from itk::simple::ImageFilter
using Self = ImageFilter
- Public Types inherited from itk::simple::ProcessObject
using Self = ProcessObject

Public Member Functions

Image Execute (const Image &image1)
Image Execute (Image &&image1)
double GetAlpha () const
double GetBeta () const
std::string GetName () const
double GetOutputMaximum () const
double GetOutputMinimum () const
SelfSetAlpha (double Alpha)
SelfSetBeta (double Beta)
SelfSetOutputMaximum (double OutputMaximum)
SelfSetOutputMinimum (double OutputMinimum)
 SigmoidImageFilter ()
std::string ToString () const
virtual ~SigmoidImageFilter ()
- Public Member Functions inherited from itk::simple::ImageFilter
 ImageFilter ()
virtual ~ImageFilter ()=0
- Public Member Functions inherited from itk::simple::ProcessObject
virtual void Abort ()
virtual int AddCommand (itk::simple::EventEnum event, const std::function< void()> &func)
 Directly add a callback to observe an event. More...
virtual int AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd)
 Add a Command Object to observer the event. More...
virtual float GetProgress () const
 An Active Measurement of the progress of execution. More...
virtual bool HasCommand (itk::simple::EventEnum event) const
 Query of this object has any registered commands for event. More...
 ProcessObject ()
virtual void RemoveAllCommands ()
 Remove all registered commands. More...
virtual ~ProcessObject ()
virtual void DebugOn ()
virtual void DebugOff ()
virtual bool GetDebug () const
virtual void SetDebug (bool debugFlag)
virtual void SetNumberOfThreads (unsigned int n)
virtual unsigned int GetNumberOfThreads () const
virtual void SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int GetNumberOfWorkUnits () const

Private Types

using MemberFunctionType = Image(Self::*)(const Image &image1)

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image &image1)

Private Attributes

double m_Alpha {1}
double m_Beta {0}
bool m_InPlace {false}
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
double m_OutputMaximum {255}
double m_OutputMinimum {0}


struct detail::MemberFunctionAddressor< MemberFunctionType >

Additional Inherited Members

- Static Public Member Functions inherited from itk::simple::ProcessObject
static bool GetGlobalDefaultDebug ()
static void GlobalDefaultDebugOff ()
static void GlobalDefaultDebugOn ()
static void SetGlobalDefaultDebug (bool debugFlag)
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()
static void SetGlobalWarningDisplay (bool flag)
static bool GetGlobalWarningDisplay ()
static double GetGlobalDefaultCoordinateTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultCoordinateTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static double GetGlobalDefaultDirectionTolerance ()
 Access the global tolerance to determine congruent spaces. More...
static void SetGlobalDefaultDirectionTolerance (double)
 Access the global tolerance to determine congruent spaces. More...
static bool SetGlobalDefaultThreader (const std::string &threader)
 Set/Get the default threader used for process objects. More...
static std::string GetGlobalDefaultThreader ()
 Set/Get the default threader used for process objects. More...
static void SetGlobalDefaultNumberOfThreads (unsigned int n)
static unsigned int GetGlobalDefaultNumberOfThreads ()
 Set/Get the default threader used for process objects. More...
- Protected Member Functions inherited from itk::simple::ImageFilter
void CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name)
void CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name)
- Protected Member Functions inherited from itk::simple::ProcessObject
virtual unsigned long AddITKObserver (const itk::EventObject &, itk::Command *)
virtual itk::ProcessObjectGetActiveProcess ()
virtual void OnActiveProcessDelete ()
virtual void onCommandDelete (const itk::simple::Command *cmd) noexcept
virtual void PreUpdate (itk::ProcessObject *p)
virtual void RemoveITKObserver (EventCommand &e)
- Protected Member Functions inherited from itk::simple::NonCopyable
 NonCopyable ()=default
 NonCopyable (const NonCopyable &)=delete
NonCopyableoperator= (const NonCopyable &)=delete
- Static Protected Member Functions inherited from itk::simple::ImageFilter
template<class TImageType >
static void FixNonZeroIndex (TImageType *img)
- Static Protected Member Functions inherited from itk::simple::ProcessObject
template<class TImageType >
static TImageType::ConstPointer CastImageToITK (const Image &img)
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector>
static Image CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img)
template<class TImageType >
static Image CastITKToImage (TImageType *img)
static const itk::EventObjectGetITKEventObject (EventEnum e)
template<typename T >
static std::ostream & ToStringHelper (std::ostream &os, const T &v)
static std::ostream & ToStringHelper (std::ostream &os, const char &v)
static std::ostream & ToStringHelper (std::ostream &os, const signed char &v)
static std::ostream & ToStringHelper (std::ostream &os, const unsigned char &v)

Detailed Description

Computes the sigmoid function pixel-wise.

A linear transformation is applied first on the argument of the sigmoid function. The resulting total transform is given by

\[ f(x) = (Max-Min) \cdot \frac{1}{\left(1+e^{- \frac{ x - \beta }{\alpha}}\right)} + Min \]

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.

See also
itk::simple::Sigmoid for the procedural interface
itk::SigmoidImageFilter for the Doxygen on the original ITK class.

Definition at line 46 of file sitkSigmoidImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

using itk::simple::SigmoidImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

Setup for member function dispatching

Definition at line 110 of file sitkSigmoidImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkSigmoidImageFilter.h.

◆ Self

Definition at line 48 of file sitkSigmoidImageFilter.h.

Constructor & Destructor Documentation

◆ ~SigmoidImageFilter()

virtual itk::simple::SigmoidImageFilter::~SigmoidImageFilter ( )


◆ SigmoidImageFilter()

itk::simple::SigmoidImageFilter::SigmoidImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute() [1/2]

Image itk::simple::SigmoidImageFilter::Execute ( const Image image1)

◆ Execute() [2/2]

Image itk::simple::SigmoidImageFilter::Execute ( Image &&  image1)

Execute the filter on the input image


◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::SigmoidImageFilter::ExecuteInternal ( const Image image1)

◆ GetAlpha()

double itk::simple::SigmoidImageFilter::GetAlpha ( ) const

Definition at line 67 of file sitkSigmoidImageFilter.h.

◆ GetBeta()

double itk::simple::SigmoidImageFilter::GetBeta ( ) const

Definition at line 75 of file sitkSigmoidImageFilter.h.

◆ GetName()

std::string itk::simple::SigmoidImageFilter::GetName ( ) const

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 94 of file sitkSigmoidImageFilter.h.

◆ GetOutputMaximum()

double itk::simple::SigmoidImageFilter::GetOutputMaximum ( ) const

Definition at line 83 of file sitkSigmoidImageFilter.h.

◆ GetOutputMinimum()

double itk::simple::SigmoidImageFilter::GetOutputMinimum ( ) const

Definition at line 91 of file sitkSigmoidImageFilter.h.

◆ SetAlpha()

Self& itk::simple::SigmoidImageFilter::SetAlpha ( double  Alpha)

◆ SetBeta()

Self& itk::simple::SigmoidImageFilter::SetBeta ( double  Beta)

◆ SetOutputMaximum()

Self& itk::simple::SigmoidImageFilter::SetOutputMaximum ( double  OutputMaximum)

◆ SetOutputMinimum()

Self& itk::simple::SigmoidImageFilter::SetOutputMinimum ( double  OutputMinimum)

◆ ToString()

std::string itk::simple::SigmoidImageFilter::ToString ( ) const

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 114 of file sitkSigmoidImageFilter.h.

Member Data Documentation

◆ m_Alpha

double itk::simple::SigmoidImageFilter::m_Alpha {1}

Definition at line 120 of file sitkSigmoidImageFilter.h.

◆ m_Beta

double itk::simple::SigmoidImageFilter::m_Beta {0}

Definition at line 123 of file sitkSigmoidImageFilter.h.

◆ m_InPlace

bool itk::simple::SigmoidImageFilter::m_InPlace {false}

Definition at line 130 of file sitkSigmoidImageFilter.h.

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::SigmoidImageFilter::m_MemberFactory

Definition at line 116 of file sitkSigmoidImageFilter.h.

◆ m_OutputMaximum

double itk::simple::SigmoidImageFilter::m_OutputMaximum {255}

Definition at line 125 of file sitkSigmoidImageFilter.h.

◆ m_OutputMinimum

double itk::simple::SigmoidImageFilter::m_OutputMinimum {0}

Definition at line 127 of file sitkSigmoidImageFilter.h.

The documentation for this class was generated from the following file: