itk::simple::ModulusImageFilter Class Reference

Computes the modulus (x % dividend) pixel-wise. More...

#include <sitkModulusImageFilter.h>

Inheritance diagram for itk::simple::ModulusImageFilter:

Collaboration diagram for itk::simple::ModulusImageFilter:

Public Types
typedef IntegerPixelIDTypeList	PixelIDTypeList
typedef ModulusImageFilter	Self
Public Types inherited from itk::simple::ImageFilter< 2 >
typedef ImageFilter	Self
Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject	Self

Public Member Functions
Image	Execute (const Image &image1, const Image &image2)
Image	Execute (const Image &image1, uint32_t constant)
Image	Execute (uint32_t constant, const Image &image2)
std::string	GetName () const
	ModulusImageFilter ()
std::string	ToString () const
virtual	~ModulusImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter< 2 >
	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::*	MemberFunction1Type) (uint32_t constant, const Image &image2)
typedef Image(Self::*	MemberFunction2Type) (const Image &image1, uint32_t constant)
typedef Image(Self::*	MemberFunctionType) (const Image &image1, const Image &image2)

Private Member Functions
template<class TImageType >
Image	ExecuteInternal (const Image &image1, const Image &image2)
template<class TImageType >
Image	ExecuteInternal (uint32_t constant, const Image &image2)
template<class TImageType >
Image	ExecuteInternal (const Image &image1, uint32_t constant)

Private Attributes
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunction1Type > >	m_MemberFactory1
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunction2Type > >	m_MemberFactory2

Friends
struct	detail::MemberFunctionAddressor< MemberFunction1Type >
struct	detail::MemberFunctionAddressor< MemberFunction2Type >
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) SITK_NOEXCEPT
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< 2 >
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 modulus (x % dividend) pixel-wise.

The input pixel type must support the c++ modulus operator (%).

If the dividend is zero, the maximum value will be returned.

Author

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also

itk::simple::Modulus for the procedural interface

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

Definition at line 46 of file sitkModulusImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::ModulusImageFilter::MemberFunction1Type) (uint32_t constant, const Image &image2)

private

Definition at line 88 of file sitkModulusImageFilter.h.

typedef Image(Self::* itk::simple::ModulusImageFilter::MemberFunction2Type) (const Image &image1, uint32_t constant)

private

Definition at line 93 of file sitkModulusImageFilter.h.

typedef Image(Self::* itk::simple::ModulusImageFilter::MemberFunctionType) (const Image &image1, const Image &image2)

private

Setup for member function dispatching

Definition at line 81 of file sitkModulusImageFilter.h.

typedef IntegerPixelIDTypeList itk::simple::ModulusImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 58 of file sitkModulusImageFilter.h.

typedef ModulusImageFilter itk::simple::ModulusImageFilter::Self

Definition at line 48 of file sitkModulusImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::ModulusImageFilter::~ModulusImageFilter ( )

virtual

Destructor

itk::simple::ModulusImageFilter::ModulusImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::ModulusImageFilter::Execute	(	const Image &	image1,
		const Image &	image2
	)

Execute the filter on the input images

Image itk::simple::ModulusImageFilter::Execute	(	const Image &	image1,
		uint32_t	constant
	)

Execute the filter with an image and a constant

Image itk::simple::ModulusImageFilter::Execute	(	uint32_t	constant,
		const Image &	image2
	)

template<class TImageType >

Image itk::simple::ModulusImageFilter::ExecuteInternal ( const Image &  image1, const Image &  image2  )

private

template<class TImageType >

Image itk::simple::ModulusImageFilter::ExecuteInternal ( uint32_t  constant, const Image &  image2  )

private

template<class TImageType >

Image itk::simple::ModulusImageFilter::ExecuteInternal ( const Image &  image1, uint32_t  constant  )

private

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 62 of file sitkModulusImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::MemberFunctionAddressor< MemberFunction1Type >

friend

Definition at line 90 of file sitkModulusImageFilter.h.

friend struct detail::MemberFunctionAddressor< MemberFunction2Type >

friend

Definition at line 95 of file sitkModulusImageFilter.h.

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 85 of file sitkModulusImageFilter.h.

Member Data Documentation

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

private

Definition at line 87 of file sitkModulusImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunction1Type> > itk::simple::ModulusImageFilter::m_MemberFactory1

private

Definition at line 91 of file sitkModulusImageFilter.h.

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunction2Type> > itk::simple::ModulusImageFilter::m_MemberFactory2

private

Definition at line 96 of file sitkModulusImageFilter.h.

---

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

• sitkModulusImageFilter.h