ITK  4.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Member Functions
itk::ComposeImageFilter< TInputImage, TOutputImage > Class Template Reference
Module ITKImageCompose

ComposeImageFilter combine several scalar images into a multicomponent image. More...

#include <itkComposeImageFilter.h>

Inheritance diagram for itk::ComposeImageFilter< TInputImage, TOutputImage >:
Collaboration diagram for itk::ComposeImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types

typedef SmartPointer< const Self > ConstPointer
typedef TInputImage InputImageType
typedef InputImageType::PixelType InputPixelType
typedef TOutputImage OutputImageType
typedef OutputImageType::PixelType OutputPixelType
typedef SmartPointer< Self > Pointer
typedef InputImageType::RegionType RegionType
typedef ComposeImageFilter Self
typedef ImageToImageFilter
< TInputImage, TOutputImage > 		Superclass

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
void SetInput1 (const InputImageType *image1)
void SetInput2 (const InputImageType *image2)
void SetInput3 (const InputImageType *image3)
 typedef (Concept::Convertible< InputPixelType, typename NumericTraits< OutputPixelType >::ValueType >) InputCovertibleToOutputCheck

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int Dimension = TInputImage::ImageDimension

Protected Member Functions

virtual void BeforeThreadedGenerateData ()
 ComposeImageFilter ()
virtual void GenerateOutputInformation (void)
virtual void ThreadedGenerateData (const RegionType &outputRegionForThread, ThreadIdType)

Private Types

typedef std::vector
< InputIteratorType > 		InputIteratorContainerType
typedef
ImageRegionConstIterator
< InputImageType > 		InputIteratorType

Private Member Functions

 ComposeImageFilter (const Self &)
template<class TPixel >
void ComputeOutputPixel (TPixel &pix, InputIteratorContainerType &inputItContainer)
template<class T >
void ComputeOutputPixel (std::complex< T > &pix, InputIteratorContainerType &inputItContainer)
void operator= (const Self &)

Detailed Description

template<class TInputImage, class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
class itk::ComposeImageFilter< TInputImage, TOutputImage >

ComposeImageFilter combine several scalar images into a multicomponent image.

ComposeImageFilter combine several scalar images into an itk::Image of vector pixel (itk::Vector, itk::RGBPixel, ...), of std::complex pixel, or in an itk::VectorImage.

Inputs and Usage
    filter->SetInput( 0, image0 );
    filter->SetInput( 1, image1 );
    ...
    filter->Update();
    itk::VectorImage< PixelType, dimension >::Pointer = filter->GetOutput();
All input images are expected to have the same template parameters and have the same size and origin.
See also:
VectorImage
Wiki Examples:

Definition at line 57 of file itkComposeImageFilter.h.

Member Typedef Documentation

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef SmartPointer< const Self > itk::ComposeImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 64 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef TInputImage itk::ComposeImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 71 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef std::vector< InputIteratorType > itk::ComposeImageFilter< TInputImage, TOutputImage >::InputIteratorContainerType [private]

Definition at line 105 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef ImageRegionConstIterator< InputImageType > itk::ComposeImageFilter< TInputImage, TOutputImage >::InputIteratorType [private]

Definition at line 104 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef InputImageType::PixelType itk::ComposeImageFilter< TInputImage, TOutputImage >::InputPixelType

Definition at line 73 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef TOutputImage itk::ComposeImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 72 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef OutputImageType::PixelType itk::ComposeImageFilter< TInputImage, TOutputImage >::OutputPixelType

Definition at line 74 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef SmartPointer< Self > itk::ComposeImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 63 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef InputImageType::RegionType itk::ComposeImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 75 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef ComposeImageFilter itk::ComposeImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 62 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::ComposeImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 65 of file itkComposeImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
itk::ComposeImageFilter< TInputImage, TOutputImage >::ComposeImageFilter ( ) [protected]

End concept checking

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
itk::ComposeImageFilter< TInputImage, TOutputImage >::ComposeImageFilter ( const Self &  ) [private]

Member Function Documentation

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
virtual void itk::ComposeImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( void  ) [protected, virtual]

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
template<class T >
void itk::ComposeImageFilter< TInputImage, TOutputImage >::ComputeOutputPixel ( std::complex< T > &  pix,
InputIteratorContainerType &  inputItContainer 
) [inline, private]

Definition at line 108 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
template<class TPixel >
void itk::ComposeImageFilter< TInputImage, TOutputImage >::ComputeOutputPixel ( TPixel &  pix,
InputIteratorContainerType &  inputItContainer 
) [inline, private]

Definition at line 115 of file itkComposeImageFilter.h.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::ComposeImageFilter< TInputImage, 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 TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
virtual void itk::ComposeImageFilter< TInputImage, TOutputImage >::GenerateOutputInformation ( void  ) [protected, virtual]

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
virtual const char* itk::ComposeImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

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

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
static Pointer itk::ComposeImageFilter< TInputImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
void itk::ComposeImageFilter< TInputImage, 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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
void itk::ComposeImageFilter< TInputImage, TOutputImage >::SetInput1 ( const InputImageType *  image1)
template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
void itk::ComposeImageFilter< TInputImage, TOutputImage >::SetInput2 ( const InputImageType *  image2)
template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
void itk::ComposeImageFilter< TInputImage, TOutputImage >::SetInput3 ( const InputImageType *  image3)
template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
virtual void itk::ComposeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const RegionType &  outputRegionForThread,
ThreadIdType   
) [protected, virtual]
template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
itk::ComposeImageFilter< TInputImage, TOutputImage >::typedef ( Concept::Convertible< InputPixelType, typename NumericTraits< OutputPixelType >::ValueType >  )

Begin concept checking This class requires InputCovertibleToOutputCheck in the form of ( Concept::Convertible< InputPixelType, typename NumericTraits<OutputPixelType>::ValueType > )

Member Data Documentation

template<class TInputImage , class TOutputImage = VectorImage<typename TInputImage::PixelType, TInputImage::ImageDimension>>
const unsigned int itk::ComposeImageFilter< TInputImage, TOutputImage >::Dimension = TInputImage::ImageDimension [static]

Definition at line 69 of file itkComposeImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Sun Dec 18 2011 23:43:44 for ITK by doxygen 1.7.4