SimpleITK  2.1.0.dev86
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ExpandImageFilter Class Reference

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

#include <sitkExpandImageFilter.h>

+ Inheritance diagram for itk::simple::ExpandImageFilter:
+ Collaboration diagram for itk::simple::ExpandImageFilter:

Public Types

using PixelIDTypeList = BasicPixelIDTypeList
 
using Self = ExpandImageFilter
 
- 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)
 
 ExpandImageFilter ()
 
std::vector< unsigned int > GetExpandFactors () const
 
InterpolatorEnum GetInterpolator () const
 
std::string GetName () const
 
SelfSetExpandFactor (unsigned int e)
 
SelfSetExpandFactors (std::vector< unsigned int > ExpandFactors)
 
SelfSetExpandFactors (unsigned int value)
 
SelfSetInterpolator (InterpolatorEnum Interpolator)
 
std::string ToString () const
 
virtual ~ExpandImageFilter ()
 
- 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)
 
template<class TImageType >
Image ExecuteInternalVectorImage (const Image &image)
 

Private Attributes

std::vector< unsigned int > m_ExpandFactors {std::vector<unsigned int>(3, 1)}
 
InterpolatorEnum m_Interpolator {itk::simple::sitkLinear}
 
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 

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 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

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

ExpandImageFilter increases the size of an image by an integer factor in each dimension using a interpolation method. The output image size in each dimension is given by:

OutputSize[j] = InputSize[j] * ExpandFactors[j]

The output values are obtained by interpolating the input image. The default interpolation type used is the LinearInterpolateImageFunction . The user can specify a particular interpolation function via SetInterpolator() . Note that the input interpolator must derive from base class InterpolateImageFunction .

This filter will produce an output with different pixel spacing that its input image such that:

OutputSpacing[j] = InputSpacing[j] / ExpandFactors[j]

The filter is templated over the input image type and the output image type.

This filter is implemented as a multithreaded filter and supports streaming.

This filter assumes that the input and output image has the same number of dimensions.

See also
InterpolateImageFunction
LinearInterpolationImageFunction
itk::simple::Expand for the procedural interface
itk::ExpandImageFilter for the Doxygen on the original ITK class.

Definition at line 61 of file sitkExpandImageFilter.h.

Member Typedef Documentation

◆ MemberFunctionType

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

Setup for member function dispatching

Definition at line 117 of file sitkExpandImageFilter.h.

◆ PixelIDTypeList

Define the pixels types supported by this filter

Definition at line 73 of file sitkExpandImageFilter.h.

◆ Self

Definition at line 63 of file sitkExpandImageFilter.h.

Constructor & Destructor Documentation

◆ ~ExpandImageFilter()

virtual itk::simple::ExpandImageFilter::~ExpandImageFilter ( )
virtual

Destructor

◆ ExpandImageFilter()

itk::simple::ExpandImageFilter::ExpandImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

◆ Execute()

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

Execute the filter on the input image

◆ ExecuteInternal()

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

◆ ExecuteInternalVectorImage()

template<class TImageType >
Image itk::simple::ExpandImageFilter::ExecuteInternalVectorImage ( const Image image)
private

Dispatched methods which calls ExecuteInteral on each component

◆ GetExpandFactors()

std::vector<unsigned int> itk::simple::ExpandImageFilter::GetExpandFactors ( ) const
inline

Get the expand factors.

Definition at line 90 of file sitkExpandImageFilter.h.

◆ GetInterpolator()

InterpolatorEnum itk::simple::ExpandImageFilter::GetInterpolator ( ) const
inline

Get/Set the interpolator function.

Definition at line 100 of file sitkExpandImageFilter.h.

◆ GetName()

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 103 of file sitkExpandImageFilter.h.

◆ SetExpandFactor()

Self& itk::simple::ExpandImageFilter::SetExpandFactor ( unsigned int  e)
inline

Custom public declarations

Definition at line 75 of file sitkExpandImageFilter.h.

◆ SetExpandFactors() [1/2]

Self& itk::simple::ExpandImageFilter::SetExpandFactors ( std::vector< unsigned int >  ExpandFactors)
inline

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

Definition at line 82 of file sitkExpandImageFilter.h.

◆ SetExpandFactors() [2/2]

Self& itk::simple::ExpandImageFilter::SetExpandFactors ( unsigned int  value)
inline

Set the values of the ExpandFactors vector all to value

Definition at line 85 of file sitkExpandImageFilter.h.

◆ SetInterpolator()

Self& itk::simple::ExpandImageFilter::SetInterpolator ( InterpolatorEnum  Interpolator)
inline

Get/Set the interpolator function.

Definition at line 95 of file sitkExpandImageFilter.h.

◆ ToString()

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

◆ detail::ExecuteInternalVectorImageAddressor< MemberFunctionType >

Definition at line 123 of file sitkExpandImageFilter.h.

◆ detail::MemberFunctionAddressor< MemberFunctionType >

Definition at line 122 of file sitkExpandImageFilter.h.

Member Data Documentation

◆ m_ExpandFactors

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

Definition at line 128 of file sitkExpandImageFilter.h.

◆ m_Interpolator

InterpolatorEnum itk::simple::ExpandImageFilter::m_Interpolator {itk::simple::sitkLinear}
private

Definition at line 131 of file sitkExpandImageFilter.h.

◆ m_MemberFactory

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

Definition at line 124 of file sitkExpandImageFilter.h.


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