itk::LabelToRGBImageFilter< TLabelImage, TOutputImage > Class Template Reference

#include <itkLabelToRGBImageFilter.h>

Inheritance diagram for itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >:

Collaboration diagram for itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >:

List of all members.

Public Types
typedef OutputPixelType::ComponentType	ComponentType
typedef SmartPointer< const Self >	ConstPointer
typedef TLabelImage	LabelImageType
typedef TLabelImage::PixelType	LabelPixelType
typedef TOutputImage	OutputImageType
typedef TOutputImage::PixelType	OutputPixelType
typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType
typedef SmartPointer< Self >	Pointer
typedef LabelToRGBImageFilter	Self
typedef UnaryFunctorImageFilter < TLabelImage, TOutputImage, Functor::LabelToRGBFunctor < typename TLabelImage::PixelType, typename TOutputImage::PixelType > >	Superclass
Public Types inherited from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >
typedef Functor::LabelToRGBFunctor < TLabelImage::PixelType, TOutputImage::PixelType >	FunctorType
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TLabelImage	InputImageType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
Public Types inherited from itk::InPlaceImageFilter< TLabelImage, TOutputImage >
typedef InputImageType::ConstPointer	InputImageConstPointer
Public Types inherited from itk::ImageToImageFilter< TLabelImage, TOutputImage >
Public Types inherited from itk::ImageSource< TOutputImage >
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
void	AddColor (ComponentType r, ComponentType g, ComponentType b)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfColors () const
void	ResetColors ()
virtual void	SetBackgroundValue (LabelPixelType _arg)
virtual const LabelPixelType &	GetBackgroundValue ()
virtual void	SetBackgroundColor (OutputPixelType _arg)
virtual const OutputPixelType &	GetBackgroundColor ()
Public Member Functions inherited from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >
FunctorType &	GetFunctor ()
const FunctorType &	GetFunctor () const
void	SetFunctor (const FunctorType &functor)
Public Member Functions inherited from itk::InPlaceImageFilter< TLabelImage, TOutputImage >
virtual bool	CanRunInPlace () const
virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace () const
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
Public Member Functions inherited from itk::ImageToImageFilter< TLabelImage, 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 TLabelImage *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 ()

Protected Member Functions
void	BeforeThreadedGenerateData (void)
void	GenerateOutputInformation ()
	LabelToRGBImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~LabelToRGBImageFilter ()
Protected Member Functions inherited from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
	UnaryFunctorImageFilter ()
virtual	~UnaryFunctorImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TLabelImage, TOutputImage >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TLabelImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
virtual void	GenerateInputRequestedRegion ()
	ImageToImageFilter ()
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	GenerateData ()
	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	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	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
	LabelToRGBImageFilter (const Self &)
void	operator= (const Self &)

Private Attributes
OutputPixelType	m_BackgroundColor
LabelPixelType	m_BackgroundValue

---

Detailed Description

template<class TLabelImage, typename TOutputImage>
class itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >

Apply a colormap to a label image.

Apply a colormap to a label image. The set of colors is a good selection of distinct colors. The user can choose to use a background value. In that case, a gray pixel with the same intensity than the background label is produced.

This code was contributed in the Insight Journal paper: "The watershed transform in ITK - discussion and new developments" by Beare R., Lehmann G. http://hdl.handle.net/1926/202 http://www.insight-journal.org/browse/publication/92

Author:

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

Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.

See also:

ScalarToRGBPixelFunctor LabelOverlayImageFilter

Definition at line 49 of file itkLabelToRGBImageFilter.h.

---

Member Typedef Documentation

template<class TLabelImage , typename TOutputImage >

typedef OutputPixelType::ComponentType itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::ComponentType

Type of the color component

Definition at line 97 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef SmartPointer< const Self > itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::ConstPointer

Reimplemented from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 60 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef TLabelImage itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::LabelImageType

Definition at line 68 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef TLabelImage::PixelType itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::LabelPixelType

Definition at line 71 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef TOutputImage itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::OutputImageType

Superclass typedefs.

Reimplemented from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 67 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef TOutputImage::PixelType itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::OutputPixelType

Definition at line 70 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef NumericTraits< OutputPixelType >::ValueType itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::OutputPixelValueType

Definition at line 72 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef SmartPointer< Self > itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::Pointer

Reimplemented from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 59 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef LabelToRGBImageFilter itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 58 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

typedef UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< typename TLabelImage::PixelType, typename TOutputImage::PixelType > > itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::Superclass

Reimplemented from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 65 of file itkLabelToRGBImageFilter.h.

---

Constructor & Destructor Documentation

template<class TLabelImage , typename TOutputImage >

itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::LabelToRGBImageFilter ( )

protected

template<class TLabelImage , typename TOutputImage >

virtual itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::~LabelToRGBImageFilter ( )

inlineprotectedvirtual

Definition at line 104 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::LabelToRGBImageFilter ( const Self &  )

private

---

Member Function Documentation

template<class TLabelImage , typename TOutputImage >

void itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::AddColor	(	ComponentType	r,
		ComponentType	g,
		ComponentType	b
	)

Add color to the LUT container

template<class TLabelImage , typename TOutputImage >

void itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::BeforeThreadedGenerateData ( void  )

protectedvirtual

Process to execute before entering the multithreaded section

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TLabelImage , typename TOutputImage >

virtual::itk::LightObject::Pointer itk::LabelToRGBImageFilter< TLabelImage, 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::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

template<class TLabelImage , typename TOutputImage >

void itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::GenerateOutputInformation ( void  )

protectedvirtual

UnaryFunctorImageFilter can produce an image which is a different resolution than its input image. As such, UnaryFunctorImageFilter needs to provide an implementation for GenerateOutputInformation() in order to inform the pipeline execution model. The original documentation of this method is below.

See also:

ProcessObject::GenerateOutputInformaton()

Reimplemented from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

template<class TLabelImage , typename TOutputImage >

virtual const OutputPixelType& itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::GetBackgroundColor ( )

virtual

Set/Get the background color in the output image

template<class TLabelImage , typename TOutputImage >

virtual const LabelPixelType& itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::GetBackgroundValue ( )

virtual

Set/Get the background value

template<class TLabelImage , typename TOutputImage >

virtual const char* itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Runtime information support.

Reimplemented from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

template<class TLabelImage , typename TOutputImage >

unsigned int itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::GetNumberOfColors

(

)

const

Get number of colors in the LUT container

template<class TLabelImage , typename TOutputImage >

static Pointer itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

template<class TLabelImage , typename TOutputImage >

void itk::LabelToRGBImageFilter< TLabelImage, 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::UnaryFunctorImageFilter< TLabelImage, TOutputImage, Functor::LabelToRGBFunctor< TLabelImage::PixelType, TOutputImage::PixelType > >.

template<class TLabelImage , typename TOutputImage >

void itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Print internal ivars

Reimplemented from itk::InPlaceImageFilter< TLabelImage, TOutputImage >.

template<class TLabelImage , typename TOutputImage >

void itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::ResetColors

(

)

Empty the color LUT container

template<class TLabelImage , typename TOutputImage >

virtual void itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::SetBackgroundColor ( OutputPixelType  _arg )

virtual

Set/Get the background color in the output image

template<class TLabelImage , typename TOutputImage >

virtual void itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::SetBackgroundValue ( LabelPixelType  _arg )

virtual

Set/Get the background value

---

Member Data Documentation

template<class TLabelImage , typename TOutputImage >

OutputPixelType itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::m_BackgroundColor

private

Definition at line 118 of file itkLabelToRGBImageFilter.h.

template<class TLabelImage , typename TOutputImage >

LabelPixelType itk::LabelToRGBImageFilter< TLabelImage, TOutputImage >::m_BackgroundValue

private

Definition at line 119 of file itkLabelToRGBImageFilter.h.

---

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

• itkLabelToRGBImageFilter.h