The base interface for SimpleITK filters that take one input image. More...

#include <sitkImageFilter.h>

Collaboration diagram for itk::simple::ImageFilter:

Detailed Description

The base interface for SimpleITK filters that take one input image.

All SimpleITK filters which take one input image should inherit from this class

Definition at line 35 of file sitkImageFilter.h.

Public Types
using	Self = ImageFilter

Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	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 std::string	GetName () const =0

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 std::string	ToString () const

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

Protected Member Functions
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
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)

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

Member Typedef Documentation

◆ Self

using itk::simple::ImageFilter::Self = ImageFilter

Definition at line 38 of file sitkImageFilter.h.

Constructor & Destructor Documentation

◆ ImageFilter()

itk::simple::ImageFilter::ImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

◆ ~ImageFilter()

virtual itk::simple::ImageFilter::~ImageFilter ( )

pure virtual

Default Destructor

Member Function Documentation

◆ CheckImageMatchingDimension()

void itk::simple::ImageFilter::CheckImageMatchingDimension	(	const Image &	image1,
		const Image &	image2,
		const std::string &	image2Name
	)

protected

Verify the dimension of image1 matches the dimension of image2, and if not then an exception is thrown.

◆ CheckImageMatchingPixelType()

void itk::simple::ImageFilter::CheckImageMatchingPixelType	(	const Image &	image1,
		const Image &	image2,
		const std::string &	image2Name
	)

protected

Verify the pixel type of image1 matches the pixel type of image2, and if different then an exception is thrown.

◆ CheckImageMatchingSize()

void itk::simple::ImageFilter::CheckImageMatchingSize	(	const Image &	image1,
		const Image &	image2,
		const std::string &	image2Name
	)

protected

Verify the size in pixel of image1 matches the size of image2, and if different then an exception is thrown.

◆ FixNonZeroIndex()

template<class TImageType >

static void itk::simple::ImageFilter::FixNonZeroIndex ( TImageType * img )

inlinestaticprotected

Definition at line 63 of file sitkImageFilter.h.

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

sitkImageFilter.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ Self

Constructor & Destructor Documentation

◆ ImageFilter()

◆ ~ImageFilter()

Member Function Documentation

◆ CheckImageMatchingDimension()

◆ CheckImageMatchingPixelType()

◆ CheckImageMatchingSize()

◆ FixNonZeroIndex()