#include <itkAggregateLabelMapFilter.h>

Inheritance diagram for itk::AggregateLabelMapFilter< TImage >:

Collaboration diagram for itk::AggregateLabelMapFilter< TImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef ImageType::ConstPointer	ImageConstPointer
typedef ImageType::Pointer	ImagePointer
typedef TImage	ImageType
typedef ImageType::IndexType	IndexType
typedef ImageType::LabelObjectType	LabelObjectType
typedef ImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef AggregateLabelMapFilter	Self
typedef InPlaceLabelMapFilter < TImage >	Superclass
Public Types inherited from itk::InPlaceLabelMapFilter< TImage >
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OutputImageType	OutputImageType
typedef InputImageType::RegionType	RegionType
typedef TImage	TOutputImage
Public Types inherited from itk::LabelMapFilter< TImage, TImage >
typedef OutputImageType::ConstPointer	OutputImageConstPointer
Public Types inherited from itk::ImageToImageFilter< TImage, TImage >
Public Types inherited from itk::ImageSource< TImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
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
Public Member Functions inherited from itk::InPlaceLabelMapFilter< TImage >
bool	CanRunInPlace () const
virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace ()
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
Public Member Functions inherited from itk::LabelMapFilter< TImage, TImage >
void	GenerateInputRequestedRegion ()
void	EnlargeOutputRequestedRegion (DataObject *)
Public Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
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 TImage *image)
Public Member Functions inherited from itk::ImageSource< TImage >
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 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	ImageDimension = TImage::ImageDimension
Static Public Attributes inherited from itk::InPlaceLabelMapFilter< TImage >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::LabelMapFilter< TImage, TImage >
Static Public Attributes inherited from itk::ImageToImageFilter< TImage, TImage >
Static Public Attributes inherited from itk::ImageSource< TImage >

Protected Member Functions
void	GenerateData ()
void	PrintSelf (std::ostream &os, Indent indent) const

	AggregateLabelMapFilter ()
	~AggregateLabelMapFilter ()
Protected Member Functions inherited from itk::InPlaceLabelMapFilter< TImage >
virtual void	AllocateOutputs ()
virtual InputImageType *	GetLabelMap ()
	InPlaceLabelMapFilter ()
	~InPlaceLabelMapFilter ()
Protected Member Functions inherited from itk::LabelMapFilter< TImage, TImage >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject)
	LabelMapFilter ()
	~LabelMapFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TImage, TImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TImage >
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
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	GenerateOutputInformation ()
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 Member Functions
	AggregateLabelMapFilter (const Self &)
void	operator= (const Self &)

Detailed Description

template<class TImage>
class itk::AggregateLabelMapFilter< TImage >

Collapses all labels into the first label.

This filter takes a label map as input and visits the pixels of all labels and assigns them to the first label of the label map. At the end of the execution of this filter, the map will contain a single filter.

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/1926/584 or http://www.insight-journal.org/browse/publication/176

Author:: Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

See also:: ShapeLabelObject, RelabelComponentImageFilter

Definition at line 44 of file itkAggregateLabelMapFilter.h.

Member Typedef Documentation

template<class TImage >

typedef SmartPointer< const Self > itk::AggregateLabelMapFilter< TImage >::ConstPointer

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 52 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef ImageType::ConstPointer itk::AggregateLabelMapFilter< TImage >::ImageConstPointer

Definition at line 57 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef ImageType::Pointer itk::AggregateLabelMapFilter< TImage >::ImagePointer

Definition at line 56 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef TImage itk::AggregateLabelMapFilter< TImage >::ImageType

Some convenient typedefs.

Definition at line 55 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef ImageType::IndexType itk::AggregateLabelMapFilter< TImage >::IndexType

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 59 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef ImageType::LabelObjectType itk::AggregateLabelMapFilter< TImage >::LabelObjectType

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 60 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef ImageType::PixelType itk::AggregateLabelMapFilter< TImage >::PixelType

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 58 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef SmartPointer< Self > itk::AggregateLabelMapFilter< TImage >::Pointer

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 51 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef AggregateLabelMapFilter itk::AggregateLabelMapFilter< TImage >::Self

Standard class typedefs.

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 49 of file itkAggregateLabelMapFilter.h.

template<class TImage >

typedef InPlaceLabelMapFilter< TImage > itk::AggregateLabelMapFilter< TImage >::Superclass

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 50 of file itkAggregateLabelMapFilter.h.

Constructor & Destructor Documentation

template<class TImage >

itk::AggregateLabelMapFilter< TImage >::AggregateLabelMapFilter ( )

inlineprotected

Begin concept checking End concept checking

Definition at line 83 of file itkAggregateLabelMapFilter.h.

template<class TImage >

itk::AggregateLabelMapFilter< TImage >::~AggregateLabelMapFilter ( )

inlineprotected

Begin concept checking End concept checking

Definition at line 84 of file itkAggregateLabelMapFilter.h.

template<class TImage >

itk::AggregateLabelMapFilter< TImage >::AggregateLabelMapFilter ( const Self & )

private

Member Function Documentation

template<class TImage >

virtual::itk::LightObject::Pointer itk::AggregateLabelMapFilter< TImage >::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::InPlaceLabelMapFilter< TImage >.

template<class TImage >

void itk::AggregateLabelMapFilter< TImage >::GenerateData ( void )

protectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:: ThreadedGenerateData()

Reimplemented from itk::ImageSource< TImage >.

template<class TImage >

virtual const char* itk::AggregateLabelMapFilter< TImage >::GetNameOfClass ( ) const

virtual

Runtime information support.

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

template<class TImage >

static Pointer itk::AggregateLabelMapFilter< TImage >::New ( )

static

Standard New method.

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

template<class TImage >

void itk::AggregateLabelMapFilter< TImage >::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::InPlaceLabelMapFilter< TImage >.

template<class TImage >

void itk::AggregateLabelMapFilter< TImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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::InPlaceLabelMapFilter< TImage >.