ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
itk::MergeLabelMapFilter< TImage > Class Template Reference

#include <itkMergeLabelMapFilter.h>

+ Inheritance diagram for itk::MergeLabelMapFilter< TImage >:
+ Collaboration diagram for itk::MergeLabelMapFilter< TImage >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef ImageType::ConstPointer ImageConstPointer
typedef ImageType::Pointer ImagePointer
typedef TImage ImageType
typedef ImageType::IndexType IndexType
typedef LabelObjectType::Pointer LabelObjectPointer
typedef ImageType::LabelObjectType LabelObjectType
enum  MethodChoice {
  KEEP = 0,
  AGGREGATE = 1,
  PACK = 2,
  STRICT = 3
}
typedef ImageType::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef MergeLabelMapFilter 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 InputImageTypeGetInput (void) const
const InputImageTypeGetInput (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 >
OutputImageTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageTypeGetOutput (void)
const OutputImageTypeGetOutput (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 ThreadIdTypeGetNumberOfThreads ()
- 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
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () 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
- Protected Member Functions inherited from itk::InPlaceLabelMapFilter< TImage >
virtual void AllocateOutputs ()
virtual InputImageTypeGetLabelMap ()
 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 ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () 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 ()

Protected Attributes

MethodChoice m_Method

Private Member Functions

 MergeLabelMapFilter (const Self &)
void MergeWithAggregate ()
void MergeWithKeep ()
void MergeWithPack ()
void MergeWithStrict ()
void operator= (const Self &)
virtual void SetMethod (MethodChoice _arg)
virtual const MethodChoiceGetMethod ()
 MergeLabelMapFilter ()
 ~MergeLabelMapFilter ()

Detailed Description

template<class TImage>
class itk::MergeLabelMapFilter< TImage >

Merges several Label Maps.

This filter takes one or more input Label Map and merges them.

SetMethod() can be used to change how the filter manage the labels from the different label maps. KEEP (0): MergeLabelMapFilter do its best to keep the label unchanged, but if a label is already used in a previous label map, a new label is assigned. AGGREGATE (1): If the same label is found several times in the label maps, the label objects with the same label are merged. PACK (2): MergeLabelMapFilter relabel all the label objects by order of processing. No conflict can occur. STRICT (3): MergeLabelMapFilter keeps the labels unchanged and raises an exception if the same label is found in several images.

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 53 of file itkMergeLabelMapFilter.h.


Member Typedef Documentation

template<class TImage >
typedef SmartPointer< const Self > itk::MergeLabelMapFilter< TImage >::ConstPointer

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 61 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef ImageType::ConstPointer itk::MergeLabelMapFilter< TImage >::ImageConstPointer

Definition at line 66 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef ImageType::Pointer itk::MergeLabelMapFilter< TImage >::ImagePointer

Definition at line 65 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef TImage itk::MergeLabelMapFilter< TImage >::ImageType

Some convenient typedefs.

Definition at line 64 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef ImageType::IndexType itk::MergeLabelMapFilter< TImage >::IndexType

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 68 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef LabelObjectType::Pointer itk::MergeLabelMapFilter< TImage >::LabelObjectPointer

Definition at line 70 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef ImageType::LabelObjectType itk::MergeLabelMapFilter< TImage >::LabelObjectType

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 69 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef ImageType::PixelType itk::MergeLabelMapFilter< TImage >::PixelType

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 67 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef SmartPointer< Self > itk::MergeLabelMapFilter< TImage >::Pointer

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 60 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef MergeLabelMapFilter itk::MergeLabelMapFilter< TImage >::Self

Standard class typedefs.

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 58 of file itkMergeLabelMapFilter.h.

template<class TImage >
typedef InPlaceLabelMapFilter< TImage > itk::MergeLabelMapFilter< TImage >::Superclass

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

Definition at line 59 of file itkMergeLabelMapFilter.h.


Member Enumeration Documentation

template<class TImage >
enum itk::MergeLabelMapFilter::MethodChoice

Begin concept checking End concept checking

Enumerator:
KEEP 
AGGREGATE 
PACK 
STRICT 

Definition at line 96 of file itkMergeLabelMapFilter.h.


Constructor & Destructor Documentation

template<class TImage >
itk::MergeLabelMapFilter< TImage >::MergeLabelMapFilter ( )
protected

Set/Get the method used to merge the label maps

template<class TImage >
itk::MergeLabelMapFilter< TImage >::~MergeLabelMapFilter ( )
inlineprotected

Set/Get the method used to merge the label maps

Definition at line 108 of file itkMergeLabelMapFilter.h.

template<class TImage >
itk::MergeLabelMapFilter< TImage >::MergeLabelMapFilter ( const Self )
private

Member Function Documentation

template<class TImage >
virtual::itk::LightObject::Pointer itk::MergeLabelMapFilter< 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::MergeLabelMapFilter< 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 MethodChoice& itk::MergeLabelMapFilter< TImage >::GetMethod ( )
virtual

Set/Get the method used to merge the label maps

template<class TImage >
virtual const char* itk::MergeLabelMapFilter< TImage >::GetNameOfClass ( ) const
virtual

Runtime information support.

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

template<class TImage >
void itk::MergeLabelMapFilter< TImage >::MergeWithAggregate ( )
private
template<class TImage >
void itk::MergeLabelMapFilter< TImage >::MergeWithKeep ( )
private
template<class TImage >
void itk::MergeLabelMapFilter< TImage >::MergeWithPack ( )
private
template<class TImage >
void itk::MergeLabelMapFilter< TImage >::MergeWithStrict ( )
private
template<class TImage >
static Pointer itk::MergeLabelMapFilter< TImage >::New ( )
static

Standard New method.

Reimplemented from itk::InPlaceLabelMapFilter< TImage >.

template<class TImage >
void itk::MergeLabelMapFilter< 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::MergeLabelMapFilter< 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 >.

template<class TImage >
virtual void itk::MergeLabelMapFilter< TImage >::SetMethod ( MethodChoice  _arg)
virtual

Set/Get the method used to merge the label maps


Member Data Documentation

template<class TImage >
const unsigned int itk::MergeLabelMapFilter< TImage >::ImageDimension = TImage::ImageDimension
static

ImageDimension constants

Definition at line 73 of file itkMergeLabelMapFilter.h.

template<class TImage >
MethodChoice itk::MergeLabelMapFilter< TImage >::m_Method
protected

Definition at line 115 of file itkMergeLabelMapFilter.h.


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