itk::ComposeImageFilter< TInputImage, TOutputImage > Class Template Reference

#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 Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::Pointer	OutputImagePointer
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

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
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput (void) const
const InputImageType *	GetInput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
virtual void	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TInputImage *image)
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	Dimension = TInputImage::ImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions
virtual void	BeforeThreadedGenerateData ()
	ComposeImageFilter ()
virtual void	GenerateOutputInformation (void)
virtual void	ThreadedGenerateData (const RegionType &outputRegionForThread, ThreadIdType)
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	GenerateInputRequestedRegion ()
	ImageToImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	GenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

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

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

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

---

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:

• All Examples

• Create a vector image from a collection of scalar images

• Compose a vector image (with 3 components) from three scalar images

• Convert a real image and an imaginary image to a complex image

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  )

protectedvirtual

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  )

inlineprivate

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  )

inlineprivate

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  )

protectedvirtual

Generate the information describing 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    )

protectedvirtual

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:

• itkComposeImageFilter.h