SimpleITK  1.3.0.dev466
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ConstantPadImageFilter Class Reference

Increase the image size by padding with a constant value. More...

#include <sitkConstantPadImageFilter.h>

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

Public Types

typedef BasicPixelIDTypeList PixelIDTypeList
 
typedef ConstantPadImageFilter 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

 ConstantPadImageFilter ()
 
Image Execute (const Image &image1)
 
Image Execute (const Image &image1, const std::vector< unsigned int > &padLowerBound, const std::vector< unsigned int > &padUpperBound, double constant)
 
double GetConstant () const
 
std::string GetName () const
 
std::vector< unsigned int > GetPadLowerBound () const
 
std::vector< unsigned int > GetPadUpperBound () const
 
SelfSetConstant (double Constant)
 
SelfSetPadLowerBound (const std::vector< unsigned int > &PadLowerBound)
 
SelfSetPadUpperBound (const std::vector< unsigned int > &PadUpperBound)
 
std::string ToString () const
 
virtual ~ConstantPadImageFilter ()
 
- 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

double m_Constant
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< unsigned int > m_PadLowerBound
 
std::vector< unsigned int > m_PadUpperBound
 

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

Increase the image size by padding with a constant value.

ConstantPadImageFilter changes the output image region. If the output image region is larger than the input image region, the extra pixels are filled in by a constant value. The output image region must be specified.

Visual explanation of padding regions. This filter is implemented as a multithreaded filter. It provides a ThreadedGenerateData() method for its implementation.

See also
WrapPadImageFilter , MirrorPadImageFilter
itk::simple::ConstantPad for the procedural interface
itk::ConstantPadImageFilter for the Doxygen on the original ITK class.

Definition at line 47 of file sitkConstantPadImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 106 of file sitkConstantPadImageFilter.h.

Define the pixels types supported by this filter

Definition at line 59 of file sitkConstantPadImageFilter.h.

Definition at line 49 of file sitkConstantPadImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::ConstantPadImageFilter::~ConstantPadImageFilter ( )
virtual

Destructor

itk::simple::ConstantPadImageFilter::ConstantPadImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

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

Execute the filter on the input image

Image itk::simple::ConstantPadImageFilter::Execute ( const Image image1,
const std::vector< unsigned int > &  padLowerBound,
const std::vector< unsigned int > &  padUpperBound,
double  constant 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ConstantPadImageFilter::ExecuteInternal ( const Image image1)
private
double itk::simple::ConstantPadImageFilter::GetConstant ( ) const
inline

Set/Get the pad value. Default is Zero.

Definition at line 87 of file sitkConstantPadImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 89 of file sitkConstantPadImageFilter.h.

std::vector<unsigned int> itk::simple::ConstantPadImageFilter::GetPadLowerBound ( ) const
inline

Definition at line 69 of file sitkConstantPadImageFilter.h.

std::vector<unsigned int> itk::simple::ConstantPadImageFilter::GetPadUpperBound ( ) const
inline

Definition at line 77 of file sitkConstantPadImageFilter.h.

Self& itk::simple::ConstantPadImageFilter::SetConstant ( double  Constant)
inline

Set/Get the pad value. Default is Zero.

Definition at line 82 of file sitkConstantPadImageFilter.h.

Self& itk::simple::ConstantPadImageFilter::SetPadLowerBound ( const std::vector< unsigned int > &  PadLowerBound)
inline

Definition at line 65 of file sitkConstantPadImageFilter.h.

Self& itk::simple::ConstantPadImageFilter::SetPadUpperBound ( const std::vector< unsigned int > &  PadUpperBound)
inline

Definition at line 73 of file sitkConstantPadImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 110 of file sitkConstantPadImageFilter.h.

Member Data Documentation

double itk::simple::ConstantPadImageFilter::m_Constant
private

Definition at line 120 of file sitkConstantPadImageFilter.h.

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

Definition at line 112 of file sitkConstantPadImageFilter.h.

std::vector<unsigned int> itk::simple::ConstantPadImageFilter::m_PadLowerBound
private

Definition at line 116 of file sitkConstantPadImageFilter.h.

std::vector<unsigned int> itk::simple::ConstantPadImageFilter::m_PadUpperBound
private

Definition at line 118 of file sitkConstantPadImageFilter.h.


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