SimpleITK  1.3.0.dev466
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

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef ExpandImageFilter 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 > &expandFactors, InterpolatorEnum interpolator)
 
 ExpandImageFilter ()
 
std::vector< unsigned int > GetExpandFactors () const
 
InterpolatorEnum GetInterpolator () const
 
std::string GetName () const
 
SelfSetExpandFactor (unsigned int e)
 
SelfSetExpandFactors (const 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< 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)
 
template<class TImageType >
Image ExecuteInternalVectorImage (const Image &image)
 

Private Attributes

std::vector< unsigned int > m_ExpandFactors
 
InterpolatorEnum m_Interpolator
 
nsstd::auto_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 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

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.

Warning
This filter only works for image with scalar pixel types. For vector images use VectorExpandImageFilter .

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

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

Definition at line 64 of file sitkExpandImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 123 of file sitkExpandImageFilter.h.

Define the pixels types supported by this filter

Definition at line 76 of file sitkExpandImageFilter.h.

Definition at line 66 of file sitkExpandImageFilter.h.

Constructor & Destructor Documentation

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

Destructor

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

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::ExpandImageFilter::Execute ( const Image image1,
const std::vector< unsigned int > &  expandFactors,
InterpolatorEnum  interpolator 
)

Execute the filter on the input image with the given parameters

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

Dispatched methods which calls ExecuteInteral on each component

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

Get the expand factors.

Definition at line 94 of file sitkExpandImageFilter.h.

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

Get/Set the interpolator function.

Definition at line 104 of file sitkExpandImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 106 of file sitkExpandImageFilter.h.

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

Custom public declarations

Definition at line 78 of file sitkExpandImageFilter.h.

Self& itk::simple::ExpandImageFilter::SetExpandFactors ( const 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 85 of file sitkExpandImageFilter.h.

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

Set the values of the ExpandFactors vector all to value

Definition at line 88 of file sitkExpandImageFilter.h.

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

Get/Set the interpolator function.

Definition at line 99 of file sitkExpandImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 129 of file sitkExpandImageFilter.h.

Definition at line 128 of file sitkExpandImageFilter.h.

Member Data Documentation

std::vector<unsigned int> itk::simple::ExpandImageFilter::m_ExpandFactors
private

Definition at line 134 of file sitkExpandImageFilter.h.

InterpolatorEnum itk::simple::ExpandImageFilter::m_Interpolator
private

Definition at line 136 of file sitkExpandImageFilter.h.

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

Definition at line 130 of file sitkExpandImageFilter.h.


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