itk::simple::BoxMeanImageFilter Class Reference

Implements a fast rectangular mean filter using the accumulator approach. More...

#include <sitkBoxMeanImageFilter.h>

Inheritance diagram for itk::simple::BoxMeanImageFilter:

Collaboration diagram for itk::simple::BoxMeanImageFilter:

Public Types
typedef BasicPixelIDTypeList	PixelIDTypeList
typedef BoxMeanImageFilter	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
	BoxMeanImageFilter ()
Image	Execute (const Image &image1)
Image	Execute (const Image &image1, const std::vector< unsigned int > &radius)
std::string	GetName () const
std::vector< unsigned int >	GetRadius () const
Self &	SetRadius (const std::vector< unsigned int > &Radius)
Self &	SetRadius (unsigned int value)
std::string	ToString () const
	~BoxMeanImageFilter ()
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)
template<class TImageType >
Image	ExecuteInternalVectorImage (const Image &image)

Private Attributes
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
std::vector< unsigned int >	m_Radius

Friends
struct	detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >
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

Implements a fast rectangular mean filter using the accumulator approach.

This code was contributed in the Insight Journal paper: "Efficient implementation of kernel filtering" by Beare R., Lehmann G https://hdl.handle.net/1926/555 http://www.insight-journal.org/browse/publication/160

Author

Richard Beare

See also

itk::simple::BoxMean for the procedural interface

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

Definition at line 44 of file sitkBoxMeanImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 90 of file sitkBoxMeanImageFilter.h.

typedef BasicPixelIDTypeList itk::simple::BoxMeanImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 56 of file sitkBoxMeanImageFilter.h.

typedef BoxMeanImageFilter itk::simple::BoxMeanImageFilter::Self

Definition at line 46 of file sitkBoxMeanImageFilter.h.

Constructor & Destructor Documentation

itk::simple::BoxMeanImageFilter::BoxMeanImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

itk::simple::BoxMeanImageFilter::~BoxMeanImageFilter

(

)

Destructor

Member Function Documentation

Image itk::simple::BoxMeanImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

Image itk::simple::BoxMeanImageFilter::Execute	(	const Image &	image1,
		const std::vector< unsigned int > &	radius
	)

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

template<class TImageType >

Image itk::simple::BoxMeanImageFilter::ExecuteInternalVectorImage ( const Image &  image )

private

Dispatched methods which calls ExecuteInteral on each component

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 72 of file sitkBoxMeanImageFilter.h.

std::vector<unsigned int> itk::simple::BoxMeanImageFilter::GetRadius ( ) const

inline

Definition at line 70 of file sitkBoxMeanImageFilter.h.

Self& itk::simple::BoxMeanImageFilter::SetRadius ( const std::vector< unsigned int > &  Radius )

inline

Definition at line 62 of file sitkBoxMeanImageFilter.h.

Self& itk::simple::BoxMeanImageFilter::SetRadius ( unsigned int  value )

inline

Set the values of the Radius vector all to value

Definition at line 65 of file sitkBoxMeanImageFilter.h.

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

friend struct detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

friend

Definition at line 97 of file sitkBoxMeanImageFilter.h.

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 96 of file sitkBoxMeanImageFilter.h.

Member Data Documentation

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

private

Definition at line 98 of file sitkBoxMeanImageFilter.h.

std::vector<unsigned int> itk::simple::BoxMeanImageFilter::m_Radius

private

Definition at line 102 of file sitkBoxMeanImageFilter.h.

---

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

• sitkBoxMeanImageFilter.h