itk::PasteImageFilter< TInputImage > Class Template Reference
[Geometric Transformation Filters]

Paste an image into another image. More...

#include <itkPasteImageFilter.h>

Inheritance diagram for itk::PasteImageFilter< TInputImage >:

[legend]Collaboration diagram for itk::PasteImageFilter< TInputImage >:

[legend]List of all members.

Public Types
typedef PasteImageFilter	Self
typedef InPlaceImageFilter< TInputImage, TInputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef TInputImage::RegionType	OutputImageRegionType
typedef TInputImage::RegionType	InputImageRegionType
typedef TInputImage::PixelType	OutputImagePixelType
typedef TInputImage::PixelType	InputImagePixelType
typedef TInputImage::IndexType	OutputImageIndexType
typedef TInputImage::IndexType	InputImageIndexType
typedef TInputImage::SizeType	OutputImageSizeType
typedef TInputImage::SizeType	InputImageSizeType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	GenerateInputRequestedRegion ()
	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TInputImage::ImageDimension)
virtual void	SetDestinationIndex (InputImageIndexType _arg)
virtual InputImageIndexType	GetDestinationIndex ()
virtual void	SetSourceRegion (InputImageRegionType _arg)
virtual InputImageRegionType	GetSourceRegion ()
void	SetDestinationImage (TInputImage *dest)
const TInputImage *	GetDestinationImage ()
void	SetSourceImage (TInputImage *src)
const TInputImage *	GetSourceImage ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	PasteImageFilter ()
	~PasteImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
Protected Attributes
InputImageRegionType	m_SourceRegion
InputImageIndexType	m_DestinationIndex

---

Detailed Description

template<class TInputImage>
class itk::PasteImageFilter< TInputImage >

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

Definition at line 43 of file itkPasteImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage> typedef SmartPointer<const Self> itk::PasteImageFilter< TInputImage >::ConstPointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 51 of file itkPasteImageFilter.h.

template<class TInputImage> typedef TInputImage::IndexType itk::PasteImageFilter< TInputImage >::InputImageIndexType

Definition at line 73 of file itkPasteImageFilter.h.

template<class TInputImage> typedef TInputImage::PixelType itk::PasteImageFilter< TInputImage >::InputImagePixelType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 69 of file itkPasteImageFilter.h.

template<class TInputImage> typedef Superclass::InputImagePointer itk::PasteImageFilter< TInputImage >::InputImagePointer

Typedefs from Superclass Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 60 of file itkPasteImageFilter.h.

template<class TInputImage> typedef TInputImage::RegionType itk::PasteImageFilter< TInputImage >::InputImageRegionType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 65 of file itkPasteImageFilter.h.

template<class TInputImage> typedef TInputImage::SizeType itk::PasteImageFilter< TInputImage >::InputImageSizeType

Definition at line 75 of file itkPasteImageFilter.h.

template<class TInputImage> typedef TInputImage::IndexType itk::PasteImageFilter< TInputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types. Definition at line 72 of file itkPasteImageFilter.h.

template<class TInputImage> typedef TInputImage::PixelType itk::PasteImageFilter< TInputImage >::OutputImagePixelType

Typedef to describe the type of pixel. Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 68 of file itkPasteImageFilter.h.

template<class TInputImage> typedef Superclass::OutputImagePointer itk::PasteImageFilter< TInputImage >::OutputImagePointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 61 of file itkPasteImageFilter.h.

template<class TInputImage> typedef TInputImage::RegionType itk::PasteImageFilter< TInputImage >::OutputImageRegionType

Typedef to describe the output and input image region types. Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 64 of file itkPasteImageFilter.h.

template<class TInputImage> typedef TInputImage::SizeType itk::PasteImageFilter< TInputImage >::OutputImageSizeType

Definition at line 74 of file itkPasteImageFilter.h.

template<class TInputImage> typedef SmartPointer<Self> itk::PasteImageFilter< TInputImage >::Pointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 50 of file itkPasteImageFilter.h.

template<class TInputImage> typedef PasteImageFilter itk::PasteImageFilter< TInputImage >::Self

Standard class typedefs. Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 48 of file itkPasteImageFilter.h.

template<class TInputImage> typedef InPlaceImageFilter<TInputImage,TInputImage> itk::PasteImageFilter< TInputImage >::Superclass

Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >. Definition at line 49 of file itkPasteImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage> itk::PasteImageFilter< TInputImage >::PasteImageFilter (   )  [protected]

template<class TInputImage> itk::PasteImageFilter< TInputImage >::~PasteImageFilter (   )  [inline, protected]

Definition at line 122 of file itkPasteImageFilter.h.

---

Member Function Documentation

template<class TInputImage> virtual void itk::PasteImageFilter< TInputImage >::GenerateInputRequestedRegion (   )  [virtual]

PasteImageFilter needs to set the input requested regions for its inputs. The first input's requested region will be set to match the output requested region. The second input's requested region will be set to the value of the m_SourceRegion ivar. Note that if the output requested region is a portion of the image that is outside the DestinationIndex + size of the source region, then the first input is copied to the output. See also: ProcessObject::GenerateInputRequestedRegion() Reimplemented from itk::ImageToImageFilter< TInputImage, TInputImage >.

template<class TInputImage> const TInputImage* itk::PasteImageFilter< TInputImage >::GetDestinationImage (   )  [inline]

Set/Get the "destination" image. This is the image that will be obscured by the paste operation. Definition at line 99 of file itkPasteImageFilter.h.

template<class TInputImage> virtual InputImageIndexType itk::PasteImageFilter< TInputImage >::GetDestinationIndex (   )  [virtual]

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

template<class TInputImage> virtual const char* itk::PasteImageFilter< TInputImage >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >.

template<class TInputImage> const TInputImage* itk::PasteImageFilter< TInputImage >::GetSourceImage (  void   )  [inline]

Set/Get the "source" image. This is the image that will be pasted over the destination imaeg. Definition at line 105 of file itkPasteImageFilter.h.

template<class TInputImage> virtual InputImageRegionType itk::PasteImageFilter< TInputImage >::GetSourceRegion (   )  [virtual]

Set/Get the source region (what part of the second input will be pasted.

template<class TInputImage> itk::PasteImageFilter< TInputImage >::itkStaticConstMacro (  OutputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

ImageDimension enumeration Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >.

template<class TInputImage> itk::PasteImageFilter< TInputImage >::itkStaticConstMacro (  InputImageDimension  , unsigned  int, TInputImage::ImageDimension  )

ImageDimension enumeration Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >.

template<class TInputImage> Pointer itk::PasteImageFilter< TInputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage> void itk::PasteImageFilter< TInputImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::InPlaceImageFilter< TInputImage, TInputImage >.

template<class TInputImage> void itk::PasteImageFilter< TInputImage >::SetDestinationImage (  TInputImage *  dest  )  [inline]

Set/Get the "destination" image. This is the image that will be obscured by the paste operation. Definition at line 98 of file itkPasteImageFilter.h.

template<class TInputImage> virtual void itk::PasteImageFilter< TInputImage >::SetDestinationIndex (  InputImageIndexType  _arg  )  [virtual]

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

template<class TInputImage> void itk::PasteImageFilter< TInputImage >::SetSourceImage (  TInputImage *  src  )  [inline]

Set/Get the "source" image. This is the image that will be pasted over the destination imaeg. Definition at line 104 of file itkPasteImageFilter.h.

template<class TInputImage> virtual void itk::PasteImageFilter< TInputImage >::SetSourceRegion (  InputImageRegionType  _arg  )  [virtual]

Set/Get the source region (what part of the second input will be pasted.

template<class TInputImage> void itk::PasteImageFilter< TInputImage >::ThreadedGenerateData (  const OutputImageRegionType &  outputRegionForThread, int  threadId )  [protected, virtual]

PasteImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread" See also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData() Reimplemented from itk::ImageSource< TInputImage >.

---

Member Data Documentation

template<class TInputImage> InputImageIndexType itk::PasteImageFilter< TInputImage >::m_DestinationIndex [protected]

Definition at line 138 of file itkPasteImageFilter.h.

template<class TInputImage> InputImageRegionType itk::PasteImageFilter< TInputImage >::m_SourceRegion [protected]

Definition at line 137 of file itkPasteImageFilter.h.

---

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

• itkPasteImageFilter.h

---