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

#include <sitkSigmoidImageFilter.h>

Inheritance diagram for itk::simple::SigmoidImageFilter:

Collaboration diagram for itk::simple::SigmoidImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList

typedef SigmoidImageFilter	Self

Public Types inherited from itk::simple::ImageFilter< 1 >
typedef ImageFilter	Self

Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1)

Image	Execute (const Image &image1, double alpha, double beta, double outputMaximum, double outputMinimum)

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

	~SigmoidImageFilter ()

Public Member Functions inherited from itk::simple::ImageFilter< 1 >
	ImageFilter ()

virtual	~ImageFilter ()=0

Public Member Functions inherited from itk::simple::ProcessObject
virtual void	Abort ()

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

Private Types
typedef Image(Self::*	MemberFunctionType) (const Image &image1)

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

Private Attributes
double	m_Alpha

double	m_Beta

nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory

double	m_OutputMaximum

double	m_OutputMinimum

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 void	SetGlobalDefaultNumberOfThreads (unsigned int n)

static unsigned int	GetGlobalDefaultNumberOfThreads ()

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...

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) throw ()

virtual void	PreUpdate (itk::ProcessObject *p)

virtual void	RemoveITKObserver (EventCommand &e)

Protected Member Functions inherited from itk::simple::NonCopyable
	NonCopyable ()

Static Protected Member Functions inherited from itk::simple::ImageFilter< 1 >
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 TImageType >
static Image	CastITKToImage (TImageType *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)

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)

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.

Wiki Examples:

All Examples

Pass image pixels through a sigmoid function
See also
itk::simple::Sigmoid for the procedural interface

itk::SigmoidImageFilter for the Doxygen on the original ITK class.

Definition at line 52 of file sitkSigmoidImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 118 of file sitkSigmoidImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::SigmoidImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkSigmoidImageFilter.h.

typedef SigmoidImageFilter itk::simple::SigmoidImageFilter::Self

Definition at line 54 of file sitkSigmoidImageFilter.h.

Constructor & Destructor Documentation

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

Default Constructor that takes no arguments and initializes default parameters

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

Destructor

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::SigmoidImageFilter::Execute	(	const Image &	image1,
		double	alpha,
		double	beta,
		double	outputMaximum,
		double	outputMinimum
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

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

inline

Definition at line 74 of file sitkSigmoidImageFilter.h.

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

inline

Definition at line 82 of file sitkSigmoidImageFilter.h.

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 100 of file sitkSigmoidImageFilter.h.

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

inline

Definition at line 90 of file sitkSigmoidImageFilter.h.

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

inline

Definition at line 98 of file sitkSigmoidImageFilter.h.

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

inline

Definition at line 70 of file sitkSigmoidImageFilter.h.

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

inline

Definition at line 78 of file sitkSigmoidImageFilter.h.

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

inline

Definition at line 86 of file sitkSigmoidImageFilter.h.

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

inline

Definition at line 94 of file sitkSigmoidImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 123 of file sitkSigmoidImageFilter.h.

Member Data Documentation

double itk::simple::SigmoidImageFilter::m_Alpha

private

Definition at line 129 of file sitkSigmoidImageFilter.h.

double itk::simple::SigmoidImageFilter::m_Beta

private

Definition at line 131 of file sitkSigmoidImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::SigmoidImageFilter::m_MemberFactory

private

Definition at line 125 of file sitkSigmoidImageFilter.h.

double itk::simple::SigmoidImageFilter::m_OutputMaximum

private

Definition at line 132 of file sitkSigmoidImageFilter.h.

double itk::simple::SigmoidImageFilter::m_OutputMinimum

private

Definition at line 133 of file sitkSigmoidImageFilter.h.

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

sitkSigmoidImageFilter.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation