SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
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:

Public Types

typedef NonLabelPixelIDTypeList PixelIDTypeList
 
typedef BinShrinkImageFilter 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

 BinShrinkImageFilter ()
 
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
 
SelfSetShrinkFactor (unsigned int s)
 
SelfSetShrinkFactors (const std::vector< unsigned int > &ShrinkFactors)
 
std::string ToString () const
 
virtual ~BinShrinkImageFilter ()
 
- 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::ProcessObjectGetActiveProcess ()
 
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< 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::EventObjectGetITKEventObject (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 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://hdl.handle.net/10380/3450

See also
itk::simple::BinShrink for the procedural interface
itk::BinShrinkImageFilter for the Doxygen on the original ITK class.

Definition at line 51 of file sitkBinShrinkImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 96 of file sitkBinShrinkImageFilter.h.

Define the pixels types supported by this filter

Definition at line 63 of file sitkBinShrinkImageFilter.h.

Definition at line 53 of file sitkBinShrinkImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

itk::simple::BinShrinkImageFilter::BinShrinkImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::BinShrinkImageFilter::Execute ( const Image image1)

Execute the filter on the input image

Image itk::simple::BinShrinkImageFilter::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::BinShrinkImageFilter::ExecuteInternal ( const Image image1)
private
std::string itk::simple::BinShrinkImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 79 of file sitkBinShrinkImageFilter.h.

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

Get the shrink factors.

Definition at line 77 of file sitkBinShrinkImageFilter.h.

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

Custom public declarations

Definition at line 65 of file sitkBinShrinkImageFilter.h.

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

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 100 of file sitkBinShrinkImageFilter.h.

Member Data Documentation

nsstd::auto_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::BinShrinkImageFilter::m_MemberFactory
private

Definition at line 102 of file sitkBinShrinkImageFilter.h.

std::vector<unsigned int> itk::simple::BinShrinkImageFilter::m_ShrinkFactors
private

Definition at line 106 of file sitkBinShrinkImageFilter.h.


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