itk::ImageToVectorImageFilter< TInputImage > Class Template Reference

#include <itkImageToVectorImageFilter.h>

Inheritance diagram for itk::ImageToVectorImageFilter< TInputImage >:

Collaboration diagram for itk::ImageToVectorImageFilter< TInputImage >:

Detailed Description

template<class TInputImage>
class itk::ImageToVectorImageFilter< TInputImage >

This class is deprecated. You should use itkComposeImageFilter instead.

This class takes as input 'n' itk::Image's and composes them into a single 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

Deprecated:

Wiki Examples:

• All Examples

• Stack scalar images into a VectorImage

Definition at line 58 of file itkImageToVectorImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::InputImageType	InputImageType
typedef VectorImage< PixelType, itkGetStaticConstMacro(Dimension) >	OutputImageType
typedef TInputImage::InternalPixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef Superclass::InputImageRegionType	RegionType
typedef ImageToVectorImageFilter	Self
typedef ImageToImageFilter < TInputImage, OutputImageType >	Superclass
Public Types inherited from itk::ImageToImageFilter< TInputImage, VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef SmartPointer< Self >	Pointer
typedef ImageToImageFilter	Self
typedef ImageSource < VectorImage < TInputImage::InternalPixelType, TInputImage::ImageDimension > >	Superclass
Public Types inherited from itk::ImageSource< VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef VectorImage < TInputImage::InternalPixelType, TInputImage::ImageDimension >	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	Superclass
Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
typedef SmartPointer< Self >	Pointer
typedef ProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	SetNthInput (unsigned int idx, const InputImageType *inputImage)
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
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)
virtual void	SetCoordinateTolerance (double _arg)
virtual double	GetCoordinateTolerance () const
virtual void	SetDirectionTolerance (double _arg)
virtual double	GetDirectionTolerance () const
Public Member Functions inherited from itk::ImageSource< VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
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 ModifiedTimeType	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, VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageSource< VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
static const unsigned int	OutputImageDimension

Protected Member Functions
virtual void	BeforeThreadedGenerateData ()
virtual void	GenerateOutputInformation (void)
	ImageToVectorImageFilter ()
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	ThreadedGenerateData (const RegionType &outputRegionForThread, ThreadIdType)
Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
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< VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	GenerateData ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const
	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)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedInputName (const DataObjectIdentifierType &) const
bool	IsIndexedOutputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const
DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) 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)
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	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
bool	AddRequiredInputName (const DataObjectIdentifierType &)
bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
void	SetRequiredInputNames (const NameArray &)
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) 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 Member Functions
	ImageToVectorImageFilter (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType
Static Protected Member Functions inherited from itk::ImageSource< VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating

Member Typedef Documentation

template<class TInputImage >

typedef SmartPointer< const Self > itk::ImageToVectorImageFilter< TInputImage >::ConstPointer

Definition at line 67 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

typedef Superclass::InputImageType itk::ImageToVectorImageFilter< TInputImage >::InputImageType

Definition at line 79 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

typedef VectorImage< PixelType, itkGetStaticConstMacro(Dimension) > itk::ImageToVectorImageFilter< TInputImage >::OutputImageType

Definition at line 75 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

typedef TInputImage::InternalPixelType itk::ImageToVectorImageFilter< TInputImage >::PixelType

Definition at line 73 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

typedef SmartPointer< Self > itk::ImageToVectorImageFilter< TInputImage >::Pointer

Definition at line 66 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

typedef Superclass::InputImageRegionType itk::ImageToVectorImageFilter< TInputImage >::RegionType

Definition at line 81 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

typedef ImageToVectorImageFilter itk::ImageToVectorImageFilter< TInputImage >::Self

Definition at line 65 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

typedef ImageToImageFilter< TInputImage, OutputImageType > itk::ImageToVectorImageFilter< TInputImage >::Superclass

Definition at line 77 of file itkImageToVectorImageFilter.h.

Constructor & Destructor Documentation

template<class TInputImage >

itk::ImageToVectorImageFilter< TInputImage >::ImageToVectorImageFilter ( )

protected

Begin concept checking End concept checking

template<class TInputImage >

itk::ImageToVectorImageFilter< TInputImage >::ImageToVectorImageFilter ( const Self &  )

private

Member Function Documentation

template<class TInputImage >

virtual void itk::ImageToVectorImageFilter< TInputImage >::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< VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >.

template<class TInputImage >

virtual::itk::LightObject::Pointer itk::ImageToVectorImageFilter< TInputImage >::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 >

virtual void itk::ImageToVectorImageFilter< TInputImage >::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 >

virtual const char* itk::ImageToVectorImageFilter< TInputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageFilter< TInputImage, VectorImage< TInputImage::InternalPixelType, TInputImage::ImageDimension > >.

template<class TInputImage >

static Pointer itk::ImageToVectorImageFilter< TInputImage >::New ( )

static

template<class TInputImage >

void itk::ImageToVectorImageFilter< TInputImage >::operator= ( const Self &  )

private

template<class TInputImage >

virtual void itk::ImageToVectorImageFilter< TInputImage >::SetNthInput ( unsigned int  idx, const InputImageType *  inputImage  )

inlinevirtual

Definition at line 83 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

virtual void itk::ImageToVectorImageFilter< TInputImage >::SetNthInput ( unsigned int  num, DataObject *  input  )

inlineprotectedvirtual

Definition at line 102 of file itkImageToVectorImageFilter.h.

template<class TInputImage >

virtual void itk::ImageToVectorImageFilter< TInputImage >::ThreadedGenerateData ( const RegionType &  outputRegionForThread, ThreadIdType    )

protectedvirtual

Member Data Documentation

template<class TInputImage >

const unsigned int itk::ImageToVectorImageFilter< TInputImage >::Dimension = TInputImage::ImageDimension

static

Definition at line 71 of file itkImageToVectorImageFilter.h.

---

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

• itkImageToVectorImageFilter.h