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

Paste an image into another image. More...

#include <sitkPasteImageFilter.h>

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

Public Types

typedef NonLabelPixelIDTypeList PixelIDTypeList
 
typedef PasteImageFilter Self
 
- Public Types inherited from itk::simple::ImageFilter< 0 >
typedef ImageFilter Self
 
- Public Types inherited from itk::simple::ProcessObject
typedef ProcessObject Self
 

Public Member Functions

Image Execute (const Image &destinationImage, const Image &sourceImage)
 
Image Execute (const Image &destinationImage, const Image &sourceImage, const std::vector< unsigned int > &sourceSize, const std::vector< int > &sourceIndex, const std::vector< int > &destinationIndex)
 
std::vector< int > GetDestinationIndex () const
 
std::string GetName () const
 
std::vector< int > GetSourceIndex () const
 
std::vector< unsigned int > GetSourceSize () const
 
 PasteImageFilter ()
 
SelfSetDestinationIndex (const std::vector< int > &DestinationIndex)
 
SelfSetSourceIndex (const std::vector< int > &SourceIndex)
 
SelfSetSourceSize (const std::vector< unsigned int > &SourceSize)
 
std::string ToString () const
 
virtual ~PasteImageFilter ()
 
- Public Member Functions inherited from itk::simple::ImageFilter< 0 >
 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 *destinationImage, const Image *sourceImage)
 

Private Member Functions

template<class TImageType >
Image ExecuteInternal (const Image *destinationImage, const Image *sourceImage)
 

Private Attributes

std::vector< int > m_DestinationIndex
 
nsstd::auto_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
 
std::vector< int > m_SourceIndex
 
std::vector< unsigned int > m_SourceSize
 

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

Paste an image into another image.

PasteImageFilter allows you to take a section of one image and paste into another image. The SetDestinationIndex() method prescribes where in the first input to start pasting data from the second input. The SetSourceRegion method prescribes the section of the second image to paste into the first. If the output requested region does not include the SourceRegion after it has been repositioned to DestinationIndex, then the output will just be a copy of the input.

The two inputs and output image will have the same pixel type.

See also
itk::simple::Paste for the procedural interface
itk::PasteImageFilter for the Doxygen on the original ITK class.

Definition at line 44 of file sitkPasteImageFilter.h.

Member Typedef Documentation

typedef Image(Self::* itk::simple::PasteImageFilter::MemberFunctionType) (const Image *destinationImage, const Image *sourceImage)
private

Setup for member function dispatching

Definition at line 103 of file sitkPasteImageFilter.h.

Define the pixels types supported by this filter

Definition at line 56 of file sitkPasteImageFilter.h.

Definition at line 46 of file sitkPasteImageFilter.h.

Constructor & Destructor Documentation

virtual itk::simple::PasteImageFilter::~PasteImageFilter ( )
virtual

Destructor

itk::simple::PasteImageFilter::PasteImageFilter ( )

Default Constructor that takes no arguments and initializes default parameters

Member Function Documentation

Image itk::simple::PasteImageFilter::Execute ( const Image destinationImage,
const Image sourceImage 
)

Execute the filter on the input image

Image itk::simple::PasteImageFilter::Execute ( const Image destinationImage,
const Image sourceImage,
const std::vector< unsigned int > &  sourceSize,
const std::vector< int > &  sourceIndex,
const std::vector< int > &  destinationIndex 
)

Execute the filter on the input image with the given parameters

template<class TImageType >
Image itk::simple::PasteImageFilter::ExecuteInternal ( const Image destinationImage,
const Image sourceImage 
)
private
std::vector<int> itk::simple::PasteImageFilter::GetDestinationIndex ( ) const
inline

Set/Get the destination index (where in the first input the second input will be pasted.

Definition at line 84 of file sitkPasteImageFilter.h.

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

Name of this class

Implements itk::simple::ProcessObject.

Definition at line 86 of file sitkPasteImageFilter.h.

std::vector<int> itk::simple::PasteImageFilter::GetSourceIndex ( ) const
inline

Definition at line 74 of file sitkPasteImageFilter.h.

std::vector<unsigned int> itk::simple::PasteImageFilter::GetSourceSize ( ) const
inline

Definition at line 66 of file sitkPasteImageFilter.h.

Self& itk::simple::PasteImageFilter::SetDestinationIndex ( const std::vector< int > &  DestinationIndex)
inline

Set/Get the destination index (where in the first input the second input will be pasted.

Definition at line 79 of file sitkPasteImageFilter.h.

Self& itk::simple::PasteImageFilter::SetSourceIndex ( const std::vector< int > &  SourceIndex)
inline

Definition at line 70 of file sitkPasteImageFilter.h.

Self& itk::simple::PasteImageFilter::SetSourceSize ( const std::vector< unsigned int > &  SourceSize)
inline

Definition at line 62 of file sitkPasteImageFilter.h.

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

Print ourselves out

Reimplemented from itk::simple::ProcessObject.

Friends And Related Function Documentation

Definition at line 107 of file sitkPasteImageFilter.h.

Member Data Documentation

std::vector<int> itk::simple::PasteImageFilter::m_DestinationIndex
private

Definition at line 114 of file sitkPasteImageFilter.h.

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

Definition at line 109 of file sitkPasteImageFilter.h.

std::vector<int> itk::simple::PasteImageFilter::m_SourceIndex
private

Definition at line 113 of file sitkPasteImageFilter.h.

std::vector<unsigned int> itk::simple::PasteImageFilter::m_SourceSize
private

Definition at line 112 of file sitkPasteImageFilter.h.


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