ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage > Class Template Reference
Geometric Transformation Filters | Module ITKImageGrid

#include <itkPasteImageFilter.h>

+ Inheritance diagram for itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >:
+ Collaboration diagram for itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef InputImageType::IndexType InputImageIndexType
typedef InputImageType::PixelType InputImagePixelType
typedef
Superclass::InputImagePointer 		InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef InputImageType::SizeType InputImageSizeType
typedef TInputImage InputImageType
typedef OutputImageType::IndexType OutputImageIndexType
typedef OutputImageType::PixelType OutputImagePixelType
typedef
Superclass::OutputImagePointer 		OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef OutputImageType::SizeType OutputImageSizeType
typedef TOutputImage OutputImageType
typedef SmartPointer< Self > Pointer
typedef PasteImageFilter Self
typedef
SourceImageType::ConstPointer 		SourceImageConstPointer
typedef SourceImageType::IndexType SourceImageIndexType
typedef SourceImageType::PixelType SourceImagePixelType
typedef SourceImageType::Pointer SourceImagePointer
typedef SourceImageType::RegionType SourceImageRegionType
typedef SourceImageType::SizeType SourceImageSizeType
typedef TSourceImage SourceImageType
typedef InPlaceImageFilter
< TInputImage, TOutputImage > 		Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion ()
const InputImageType * GetDestinationImage () const
virtual const char * GetNameOfClass () const
const SourceImageType * GetSourceImage () const
void SetDestinationImage (const InputImageType *dest)
void SetSourceImage (const SourceImageType *src)
virtual void VerifyInputInformation ()
virtual void SetDestinationIndex (InputImageIndexType _arg)
virtual InputImageIndexType GetDestinationIndex () const
virtual void SetSourceRegion (SourceImageRegionType _arg)
virtual SourceImageRegionType GetSourceRegion () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int InputImageDimension = InputImageType::ImageDimension
static const unsigned int OutputImageDimension = OutputImageType::ImageDimension
static const unsigned int SourceImageDimension = SourceImageType::ImageDimension

Protected Member Functions

 PasteImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 ~PasteImageFilter ()

Protected Attributes

InputImageIndexType m_DestinationIndex
SourceImageRegionType m_SourceRegion

Private Member Functions

void operator= (const Self &)
 PasteImageFilter (const Self &)

Detailed Description

template<class TInputImage, class TSourceImage = TInputImage, class TOutputImage = TInputImage>
class itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >

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.

Wiki Examples:

Definition at line 48 of file itkPasteImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef SmartPointer< const Self > itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::ConstPointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 56 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef InputImageType::IndexType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageIndexType

Definition at line 87 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef InputImageType::PixelType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImagePixelType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 81 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::InputImagePointer itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImagePointer

Typedefs from Superclass

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 62 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef InputImageType::RegionType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageRegionType

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 73 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef InputImageType::SizeType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageSizeType

Definition at line 88 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef TInputImage itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageType

Typedef to describe the output and input image region types.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 69 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef OutputImageType::IndexType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageIndexType

Typedef to describe the output and input image index and size types.

Definition at line 85 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef OutputImageType::PixelType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImagePixelType

Typedef to describe the type of pixel.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 80 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef Superclass::OutputImagePointer itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImagePointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 66 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef OutputImageType::RegionType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 72 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef OutputImageType::SizeType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageSizeType

Definition at line 86 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef TOutputImage itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageType

Superclass typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 70 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef SmartPointer< Self > itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::Pointer

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 55 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef PasteImageFilter itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 53 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef SourceImageType::ConstPointer itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageConstPointer

Definition at line 77 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef SourceImageType::IndexType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageIndexType

Definition at line 89 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef SourceImageType::PixelType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImagePixelType

Definition at line 82 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef SourceImageType::Pointer itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImagePointer

Definition at line 76 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef SourceImageType::RegionType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageRegionType

Definition at line 74 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef SourceImageType::SizeType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageSizeType

Definition at line 90 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
typedef TSourceImage itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageType

Definition at line 71 of file itkPasteImageFilter.h.

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

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 54 of file itkPasteImageFilter.h.

Constructor & Destructor Documentation

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

Definition at line 146 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::PasteImageFilter ( const Self &  ) [private]

Member Function Documentation

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
virtual::itk::LightObject::Pointer itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::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, TOutputImage >.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
const InputImageType* itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetDestinationImage ( ) const
template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
virtual InputImageIndexType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetDestinationIndex ( ) const [virtual]

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

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

Run-time type information (and related methods).

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
const SourceImageType* itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetSourceImage ( ) const
template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
virtual SourceImageRegionType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::GetSourceRegion ( ) const [virtual]

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

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
static Pointer itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::operator= ( const Self &  ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::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, TOutputImage >.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetDestinationImage ( const InputImageType *  dest)

Set/Get the "destination" image. This is the image that will be obscured by the paste operation.

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

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

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetSourceImage ( const SourceImageType *  src)

Set/Get the "source" image. This is the image that will be pasted over the destination image.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SetSourceRegion ( SourceImageRegionType  _arg) [virtual]

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

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread,
ThreadIdType  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< TOutputImage >.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
virtual void itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::VerifyInputInformation ( ) [inline, virtual]

Override VeriyInputInformation() since this filter's inputs do not need to occoupy the same physical space.

See also:
ProcessObject::VerifyInputInformation

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

Definition at line 142 of file itkPasteImageFilter.h.

Member Data Documentation

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
const unsigned int itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::InputImageDimension = InputImageType::ImageDimension [static]

ImageDimension enumeration

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 94 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
InputImageIndexType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::m_DestinationIndex [protected]

Definition at line 163 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
SourceImageRegionType itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::m_SourceRegion [protected]

Definition at line 161 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
const unsigned int itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::OutputImageDimension = OutputImageType::ImageDimension [static]

ImageDimension enumeration

Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.

Definition at line 96 of file itkPasteImageFilter.h.

template<class TInputImage , class TSourceImage = TInputImage, class TOutputImage = TInputImage>
const unsigned int itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::SourceImageDimension = SourceImageType::ImageDimension [static]

ImageDimension enumeration

Definition at line 98 of file itkPasteImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 01:15:59 for ITK by doxygen 1.7.6.1