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

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

Public Member Functions

Image Execute (const Image &image1)
 
std::string GetName () const
 
std::vector< unsigned int > GetShrinkFactors () const
 
SelfSetShrinkFactor (unsigned int s)
 
SelfSetShrinkFactors (std::vector< unsigned int > ShrinkFactors)
 
 ShrinkImageFilter ()
 
std::string ToString () const
 
virtual ~ShrinkImageFilter ()
 
- 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::ProcessObjectGetActiveProcess ()
 
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
 
NonCopyableoperator= (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<class TImageType >
static Image CastITKToImage (TImageType *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.

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 DynamicThreadedGenerateData() method for its implementation.

See also
itk::simple::Shrink for the procedural interface
itk::ShrinkImageFilter for the Doxygen on the original ITK class.

Definition at line 48 of file sitkShrinkImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 91 of file sitkShrinkImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 60 of file sitkShrinkImageFilter.h.

◆ Self

Definition at line 50 of file sitkShrinkImageFilter.h.

Constructor & Destructor Documentation

◆ ~ShrinkImageFilter()

virtual itk::simple::ShrinkImageFilter::~ShrinkImageFilter ( )
virtual

Destructor

◆ ShrinkImageFilter()

itk::simple::ShrinkImageFilter::ShrinkImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

template<class TImageType >
Image itk::simple::ShrinkImageFilter::ExecuteInternal ( const Image image1)
private

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 77 of file sitkShrinkImageFilter.h.

◆ GetShrinkFactors()

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

Get the shrink factors.

Definition at line 74 of file sitkShrinkImageFilter.h.

◆ SetShrinkFactor()

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

Custom public declarations

Definition at line 62 of file sitkShrinkImageFilter.h.

◆ SetShrinkFactors()

Self& itk::simple::ShrinkImageFilter::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 69 of file sitkShrinkImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 95 of file sitkShrinkImageFilter.h.

Member Data Documentation

◆ m_MemberFactory

std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > itk::simple::ShrinkImageFilter::m_MemberFactory
private

Definition at line 97 of file sitkShrinkImageFilter.h.

◆ m_ShrinkFactors

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

Definition at line 101 of file sitkShrinkImageFilter.h.


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