itk::simple::ShrinkImageFilter Class Reference

Reduce the size of an image by an integer factor in each dimension. More...

#include <sitkShrinkImageFilter.h>

Inheritance diagram for itk::simple::ShrinkImageFilter:

Collaboration diagram for itk::simple::ShrinkImageFilter:

Public Types
typedef NonLabelPixelIDTypeList	PixelIDTypeList
typedef ShrinkImageFilter	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, const std::vector< unsigned int > &shrinkFactors)
std::string	GetName () const
std::vector< unsigned int >	GetShrinkFactors () const
Self &	SetShrinkFactor (unsigned int s)
Self &	SetShrinkFactors (const std::vector< unsigned int > &ShrinkFactors)
	ShrinkImageFilter ()
std::string	ToString () const
	~ShrinkImageFilter ()
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
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
std::vector< unsigned int >	m_ShrinkFactors

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

Reduce the size of an image by an integer factor in each dimension.

ShrinkImageFilter reduces the size of an image by an integer factor in each dimension. The algorithm implemented is a simple subsample. The output image size in each dimension is given by:

outputSize[j] = max( std::floor(inputSize[j]/shrinkFactor[j]), 1 );

NOTE: The physical centers of the input and output will be the same. Because of this, the Origin of the output may not be the same as the Origin of the input. Since this filter produces an image which is a different resolution, origin and with different pixel spacing than its input image, it needs to override several of the methods defined in ProcessObject in order to properly manage the pipeline execution model. In particular, this filter overrides ProcessObject::GenerateInputRequestedRegion() and ProcessObject::GenerateOutputInformation() .

This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

Wiki Examples:

• All Examples

• Shrink an image

  See also

  itk::simple::Shrink for the procedural interface

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

Definition at line 54 of file sitkShrinkImageFilter.h.

Member Typedef Documentation

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

private

Setup for member function dispatching

Definition at line 100 of file sitkShrinkImageFilter.h.

typedef NonLabelPixelIDTypeList itk::simple::ShrinkImageFilter::PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 66 of file sitkShrinkImageFilter.h.

typedef ShrinkImageFilter itk::simple::ShrinkImageFilter::Self

Definition at line 56 of file sitkShrinkImageFilter.h.

Constructor & Destructor Documentation

itk::simple::ShrinkImageFilter::ShrinkImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

itk::simple::ShrinkImageFilter::~ShrinkImageFilter

(

)

Destructor

Member Function Documentation

Image itk::simple::ShrinkImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

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

Execute the filter on the input image with the given parameters

template<class TImageType >

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

private

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 82 of file sitkShrinkImageFilter.h.

std::vector<unsigned int> itk::simple::ShrinkImageFilter::GetShrinkFactors ( ) const

inline

Get the shrink factors.

Definition at line 80 of file sitkShrinkImageFilter.h.

Self& itk::simple::ShrinkImageFilter::SetShrinkFactor ( unsigned int  s )

inline

Custom public declarations

Definition at line 68 of file sitkShrinkImageFilter.h.

Self& itk::simple::ShrinkImageFilter::SetShrinkFactors ( const std::vector< unsigned int > &  ShrinkFactors )

inline

Set the shrink factors. Values are clamped to a minimum value of 1. Default is 1 for all dimensions.

Definition at line 75 of file sitkShrinkImageFilter.h.

std::string itk::simple::ShrinkImageFilter::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 105 of file sitkShrinkImageFilter.h.

Member Data Documentation

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

private

Definition at line 107 of file sitkShrinkImageFilter.h.

std::vector<unsigned int> itk::simple::ShrinkImageFilter::m_ShrinkFactors

private

Definition at line 111 of file sitkShrinkImageFilter.h.

---

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

• sitkShrinkImageFilter.h