SimpleITK  1.0.1
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
itk::simple::ZeroFluxNeumannPadImageFilter Class Reference

Increase the image size by padding according to the zero-flux Neumann boundary condition. More...

#include <sitkZeroFluxNeumannPadImageFilter.h>

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

Public Types

typedef NonLabelPixelIDTypeList PixelIDTypeList
 
typedef ZeroFluxNeumannPadImageFilter 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 > &padLowerBound, const std::vector< unsigned int > &padUpperBound)
 
std::string GetName () const
 
std::vector< unsigned int > GetPadLowerBound () const
 
std::vector< unsigned int > GetPadUpperBound () const
 
SelfSetPadLowerBound (const std::vector< unsigned int > &PadLowerBound)
 
SelfSetPadUpperBound (const std::vector< unsigned int > &PadUpperBound)
 
std::string ToString () const
 
 ZeroFluxNeumannPadImageFilter ()
 
 ~ZeroFluxNeumannPadImageFilter ()
 
- 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_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) throw ()
 
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 according to the zero-flux Neumann boundary condition.

A filter which extends the image size and fill the missing pixels according to a Neumann boundary condition where first, upwind derivatives on the boundary are zero. This is a useful condition in solving some classes of differential equations.

For example, invoking this filter on an image with a corner like:

* * * * * * *
* * * * * * *
* * 1 2 3 4 5 (where * denotes pixels that lie
* * 3 3 5 5 6 outside of the image boundary)
* * 4 4 6 7 8

returns the following padded image:

1 1 1 2 3 4 5
1 1 1 2 3 4 5
1 1 1 2 3 4 5
3 3 3 3 5 5 6 (note the corner values)
4 4 4 4 6 7 8
Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
See also
WrapPadImageFilter , MirrorPadImageFilter , ConstantPadImageFilter , ZeroFluxNeumannBoundaryCondition
itk::simple::ZeroFluxNeumannPad for the procedural interface
itk::ZeroFluxNeumannPadImageFilter for the Doxygen on the original ITK class.

Definition at line 75 of file sitkZeroFluxNeumannPadImageFilter.h.

Member Typedef Documentation

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

Setup for member function dispatching

Definition at line 125 of file sitkZeroFluxNeumannPadImageFilter.h.

Define the pixels types supported by this filter

Definition at line 87 of file sitkZeroFluxNeumannPadImageFilter.h.

Definition at line 77 of file sitkZeroFluxNeumannPadImageFilter.h.

Constructor & Destructor Documentation

itk::simple::ZeroFluxNeumannPadImageFilter::ZeroFluxNeumannPadImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

itk::simple::ZeroFluxNeumannPadImageFilter::~ZeroFluxNeumannPadImageFilter ( )

Destructor

Member Function Documentation

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

Execute the filter on the input image

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

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::ZeroFluxNeumannPadImageFilter::ExecuteInternal ( const Image image1)
private
std::string itk::simple::ZeroFluxNeumannPadImageFilter::GetName ( ) const
inlinevirtual

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 107 of file sitkZeroFluxNeumannPadImageFilter.h.

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

Definition at line 97 of file sitkZeroFluxNeumannPadImageFilter.h.

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

Definition at line 105 of file sitkZeroFluxNeumannPadImageFilter.h.

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

Definition at line 93 of file sitkZeroFluxNeumannPadImageFilter.h.

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

Definition at line 101 of file sitkZeroFluxNeumannPadImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 130 of file sitkZeroFluxNeumannPadImageFilter.h.

Member Data Documentation

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

Definition at line 132 of file sitkZeroFluxNeumannPadImageFilter.h.

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

Definition at line 135 of file sitkZeroFluxNeumannPadImageFilter.h.

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

Definition at line 136 of file sitkZeroFluxNeumannPadImageFilter.h.


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