itk::simple::BinShrinkImageFilter Class Reference

Reduce the size of an image by an integer factor in each dimension while performing averaging of an input neighborhood. More...

#include <sitkBinShrinkImageFilter.h>

Inheritance diagram for itk::simple::BinShrinkImageFilter:

Collaboration diagram for itk::simple::BinShrinkImageFilter:

Detailed Description

Reduce the size of an image by an integer factor in each dimension while performing averaging of an input neighborhood.

The output image size in each dimension is given by:

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

The algorithm implemented can be describe with the following equation for 2D:

\[ \mathsf{I}_{out}(x_o,x_1) = \frac{\sum_{i=0}^{f_0}\sum_{j=0}^{f_1}\mathsf{I}_{in}(f_0 x_o+i,f_1 x_1+j)}{f_0 f_1} \]

This filter is implemented so that the starting extent of the first pixel of the output matches that of the input.

The change in image geometry from a 5x5 image binned by a factor of 2x2.

This code was contributed in the Insight Journal paper: "BinShrink: A multi-resolution filter with cache efficient averaging" by Lowekamp B., Chen D. https://doi.org/10.54294/p39qox

See also

itk::simple::BinShrink for the procedural interface

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

Definition at line 52 of file sitkBinShrinkImageFilter.h.

Public Types
using	PixelIDTypeList = NonLabelPixelIDTypeList
using	Self = BinShrinkImageFilter
Public Types inherited from itk::simple::ImageFilter
using	Self = ImageFilter
Public Types inherited from itk::simple::ProcessObject
using	Self = ProcessObject

Public Member Functions
	BinShrinkImageFilter ()
Image	Execute (const Image &image1)
std::string	GetName () const
std::vector< unsigned int >	GetShrinkFactors () const
Self &	SetShrinkFactor (unsigned int s)
Self &	SetShrinkFactors (std::vector< unsigned int > ShrinkFactors)
std::string	ToString () const
virtual	~BinShrinkImageFilter ()
Public Member Functions inherited from itk::simple::ImageFilter
	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 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
virtual void	SetNumberOfWorkUnits (unsigned int n)
virtual unsigned int	GetNumberOfWorkUnits () const

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

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

Private Attributes
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > >	m_MemberFactory
std::vector< unsigned int >	m_ShrinkFactors {std::vector<unsigned int>(3, 1)}

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 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...
Protected Member Functions inherited from itk::simple::ImageFilter
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 inherited from itk::simple::ImageFilter
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)

Member Typedef Documentation

MemberFunctionType

using itk::simple::BinShrinkImageFilter::MemberFunctionType = Image (Self::*)( const Image& image1 )

private

Setup for member function dispatching

Definition at line 95 of file sitkBinShrinkImageFilter.h.

PixelIDTypeList

using itk::simple::BinShrinkImageFilter::PixelIDTypeList = NonLabelPixelIDTypeList

Define the pixels types supported by this filter

Definition at line 64 of file sitkBinShrinkImageFilter.h.

Self

using itk::simple::BinShrinkImageFilter::Self = BinShrinkImageFilter

Definition at line 54 of file sitkBinShrinkImageFilter.h.

Constructor & Destructor Documentation

~BinShrinkImageFilter()

virtual itk::simple::BinShrinkImageFilter::~BinShrinkImageFilter ( )

virtual

Destructor

BinShrinkImageFilter()

itk::simple::BinShrinkImageFilter::BinShrinkImageFilter

(

)

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Execute()

Image itk::simple::BinShrinkImageFilter::Execute

(

const Image &

image1

)

Execute the filter on the input image

ExecuteInternal()

template<class TImageType >

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

private

GetName()

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

inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 81 of file sitkBinShrinkImageFilter.h.

GetShrinkFactors()

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

inline

Get the shrink factors.

Definition at line 78 of file sitkBinShrinkImageFilter.h.

SetShrinkFactor()

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

inline

Custom public declarations

Definition at line 66 of file sitkBinShrinkImageFilter.h.

SetShrinkFactors()

Self& itk::simple::BinShrinkImageFilter::SetShrinkFactors ( 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 73 of file sitkBinShrinkImageFilter.h.

ToString()

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

virtual

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

detail::MemberFunctionAddressor< MemberFunctionType >

friend struct detail::MemberFunctionAddressor< MemberFunctionType >

friend

Definition at line 99 of file sitkBinShrinkImageFilter.h.

Member Data Documentation

m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::BinShrinkImageFilter::m_MemberFactory

private

Definition at line 101 of file sitkBinShrinkImageFilter.h.

m_ShrinkFactors

std::vector<unsigned int> itk::simple::BinShrinkImageFilter::m_ShrinkFactors {std::vector<unsigned int>(3, 1)}

private

Definition at line 105 of file sitkBinShrinkImageFilter.h.

---

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

• sitkBinShrinkImageFilter.h