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

#include <sitkSigmoidImageFilter.h>

Inheritance diagram for itk::simple::SigmoidImageFilter:

Collaboration diagram for itk::simple::SigmoidImageFilter:

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.

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 45 of file sitkSigmoidImageFilter.h.

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

Self &	SetAlpha (double Alpha)

Self &	SetBeta (double Beta)

Self &	SetOutputMaximum (double OutputMaximum)

Self &	SetOutputMinimum (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}

Friends
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::ProcessObject *	GetActiveProcess ()

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

NonCopyable &	operator= (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<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector>
static Image	CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img)

template<class TImageType >
static Image	CastITKToImage (TImageType *img)

static const itk::EventObject &	GetITKEventObject (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)

Member Typedef Documentation

◆ MemberFunctionType

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

private

Setup for member function dispatching

Definition at line 109 of file sitkSigmoidImageFilter.h.

◆ PixelIDTypeList

using itk::simple::SigmoidImageFilter::PixelIDTypeList = BasicPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 57 of file sitkSigmoidImageFilter.h.

◆ Self

using itk::simple::SigmoidImageFilter::Self = SigmoidImageFilter

Definition at line 47 of file sitkSigmoidImageFilter.h.

Constructor & Destructor Documentation

◆ ~SigmoidImageFilter()

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

virtual

Destructor

◆ 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

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

◆ ExecuteInternal()

template<class TImageType >

Image itk::simple::SigmoidImageFilter::ExecuteInternal ( const Image & image1 )

private

◆ GetAlpha()

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

inline

Definition at line 66 of file sitkSigmoidImageFilter.h.

◆ GetBeta()

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

inline

Definition at line 74 of file sitkSigmoidImageFilter.h.

◆ GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 93 of file sitkSigmoidImageFilter.h.

◆ GetOutputMaximum()

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

inline

Definition at line 82 of file sitkSigmoidImageFilter.h.

◆ GetOutputMinimum()

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

inline

Definition at line 90 of file sitkSigmoidImageFilter.h.

◆ SetAlpha()

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

inline

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 62 of file sitkSigmoidImageFilter.h.

◆ SetBeta()

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

inline

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 70 of file sitkSigmoidImageFilter.h.

◆ SetOutputMaximum()

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

inline

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 78 of file sitkSigmoidImageFilter.h.

◆ SetOutputMinimum()

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

inline

Examples: FastMarchingSegmentation/FastMarchingSegmentation.cxx.

Definition at line 86 of file sitkSigmoidImageFilter.h.

◆ ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 113 of file sitkSigmoidImageFilter.h.

Member Data Documentation

◆ m_Alpha

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

private

Definition at line 119 of file sitkSigmoidImageFilter.h.

◆ m_Beta

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

private

Definition at line 122 of file sitkSigmoidImageFilter.h.

◆ m_InPlace

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

private

Definition at line 129 of file sitkSigmoidImageFilter.h.

◆ m_MemberFactory

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

private

Definition at line 115 of file sitkSigmoidImageFilter.h.

◆ m_OutputMaximum

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

private

Definition at line 124 of file sitkSigmoidImageFilter.h.

◆ m_OutputMinimum

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

private

Definition at line 126 of file sitkSigmoidImageFilter.h.

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

sitkSigmoidImageFilter.h

Detailed Description

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ MemberFunctionType

◆ PixelIDTypeList

◆ Self

Constructor & Destructor Documentation

◆ ~SigmoidImageFilter()

◆ SigmoidImageFilter()

Member Function Documentation

◆ Execute() [1/2]

◆ Execute() [2/2]

◆ ExecuteInternal()

◆ GetAlpha()

◆ GetBeta()

◆ GetName()

◆ GetOutputMaximum()

◆ GetOutputMinimum()

◆ SetAlpha()

◆ SetBeta()

◆ SetOutputMaximum()

◆ SetOutputMinimum()

◆ ToString()

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Member Data Documentation

◆ m_Alpha

◆ m_Beta

◆ m_InPlace

◆ m_MemberFactory

◆ m_OutputMaximum

◆ m_OutputMinimum