ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage > Class Template Reference
MultiThreaded Filters | Module ITKImageFusion

#include <itkLabelOverlayImageFilter.h>

+ Inheritance diagram for itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >:
+ Collaboration diagram for itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >:

List of all members.

Public Types

typedef
OutputPixelType::ComponentType 		ComponentType
typedef SmartPointer< const Self > ConstPointer
typedef TInputImage InputImageType
typedef TInputImage::PixelType InputPixelType
typedef TLabelImage LabelImageType
typedef TLabelImage::PixelType LabelPixelType
typedef TOutputImage OutputImageType
typedef TOutputImage::PixelType OutputPixelType
typedef SmartPointer< Self > Pointer
typedef LabelOverlayImageFilter Self
typedef
BinaryFunctorImageFilter
< TInputImage, TLabelImage,
TOutputImage,
Functor::LabelOverlayFunctor
< typename
TInputImage::PixelType,
typename
TLabelImage::PixelType,
typename
TOutputImage::PixelType > > 		Superclass

Public Member Functions

void AddColor (ComponentType r, ComponentType g, ComponentType b)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
const LabelImageType * GetLabelImage () const
virtual const char * GetNameOfClass () const
unsigned int GetNumberOfColors () const
void ResetColors ()
void SetLabelImage (const TLabelImage *input)
 typedef (Concept::HasValueType< OutputPixelType >) OutputPixelShouldHaveValueType
 typedef (Concept::BracketOperator< OutputPixelType, unsigned int, typename OutputPixelType::ValueType >) OutputPixelShouldHaveBracketOperator
virtual void SetOpacity (double _arg)
virtual const double & GetOpacity ()
virtual void SetBackgroundValue (LabelPixelType _arg)
virtual const LabelPixelType & GetBackgroundValue ()

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void BeforeThreadedGenerateData (void)
void GenerateOutputInformation ()
 LabelOverlayImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~LabelOverlayImageFilter ()

Private Member Functions

 LabelOverlayImageFilter (const Self &)
void operator= (const Self &)

Private Attributes

LabelPixelType m_BackgroundValue
double m_Opacity

Detailed Description

template<typename TInputImage, class TLabelImage, typename TOutputImage>
class itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >

Apply a colormap to a label image and put it on top of the input image.

Apply a colormap to a label image and put it on top of the input image. The set of colors is a good selection of distinct colors. The opacity of the label image can be defined by the user. The user can also choose if the want to use a background and which label value is the background. A background label produce a gray pixel with the same intensity than the input one.

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

This class was contributed to the Insight Journal http://hdl.handle.net/1926/172

See also:
ScalarToRGBPixelFunctor LabelToRGBImageFilter
Wiki Examples:

Definition at line 54 of file itkLabelOverlayImageFilter.h.

Member Typedef Documentation

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef OutputPixelType::ComponentType itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::ComponentType

type of the color component

Definition at line 127 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef SmartPointer< const Self > itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::ConstPointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 73 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef TInputImage itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 77 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef TInputImage::PixelType itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::InputPixelType

Definition at line 81 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef TLabelImage itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::LabelImageType

Definition at line 76 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef TLabelImage::PixelType itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::LabelPixelType

Definition at line 80 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef TOutputImage itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::OutputImageType

Superclass typedefs.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 75 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef TOutputImage::PixelType itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::OutputPixelType

Definition at line 79 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef SmartPointer< Self > itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::Pointer

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 72 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef LabelOverlayImageFilter itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 64 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
typedef BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< typename TInputImage::PixelType, typename TLabelImage::PixelType, typename TOutputImage::PixelType > > itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::Superclass

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

Definition at line 70 of file itkLabelOverlayImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , class TLabelImage , typename TOutputImage >
itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::LabelOverlayImageFilter ( ) [protected]
template<typename TInputImage , class TLabelImage , typename TOutputImage >
virtual itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::~LabelOverlayImageFilter ( ) [inline, protected, virtual]

Definition at line 134 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::LabelOverlayImageFilter ( const Self &  ) [private]

Member Function Documentation

template<typename TInputImage , class TLabelImage , typename TOutputImage >
void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::AddColor ( ComponentType  r,
ComponentType  g,
ComponentType  b 
)

Add color to the LUT container

template<typename TInputImage , class TLabelImage , typename TOutputImage >
void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::BeforeThreadedGenerateData ( void  ) [protected, virtual]

Process to execute before entering the multithreaded section

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::LabelOverlayImageFilter< TInputImage, 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::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GenerateOutputInformation ( ) [protected, virtual]

Generate the information decribing 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::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
virtual const LabelPixelType& itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetBackgroundValue ( ) [virtual]

Set/Get the background value

template<typename TInputImage , class TLabelImage , typename TOutputImage >
const LabelImageType* itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetLabelImage ( ) const

Get the label image

template<typename TInputImage , class TLabelImage , typename TOutputImage >
virtual const char* itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetNameOfClass ( ) const [virtual]

Runtime information support.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
unsigned int itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetNumberOfColors ( ) const

Get number of colors in the LUT container

template<typename TInputImage , class TLabelImage , typename TOutputImage >
virtual const double& itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::GetOpacity ( ) [virtual]

Set/Get the opacity of the colored label image. The value must be between 0 and 1

template<typename TInputImage , class TLabelImage , typename TOutputImage >
static Pointer itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
void itk::LabelOverlayImageFilter< TInputImage, 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::BinaryFunctorImageFilter< TInputImage, TLabelImage, TOutputImage, Functor::LabelOverlayFunctor< TInputImage::PixelType, TLabelImage::PixelType, TOutputImage::PixelType > >.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Print internal ivars

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

template<typename TInputImage , class TLabelImage , typename TOutputImage >
void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::ResetColors ( )

End concept checking Empty the color LUT container

template<typename TInputImage , class TLabelImage , typename TOutputImage >
virtual void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::SetBackgroundValue ( LabelPixelType  _arg) [virtual]

Set/Get the background value

template<typename TInputImage , class TLabelImage , typename TOutputImage >
void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::SetLabelImage ( const TLabelImage *  input)

Set the label image

template<typename TInputImage , class TLabelImage , typename TOutputImage >
virtual void itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::SetOpacity ( double  _arg) [virtual]

Set/Get the opacity of the colored label image. The value must be between 0 and 1

template<typename TInputImage , class TLabelImage , typename TOutputImage >
itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::typedef ( Concept::HasValueType< OutputPixelType >  )

Begin concept checking This class requires OutputPixelShouldHaveValueType in the form of ( Concept::HasValueType< OutputPixelType > )

template<typename TInputImage , class TLabelImage , typename TOutputImage >
itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::typedef ( Concept::BracketOperator< OutputPixelType, unsigned int, typename OutputPixelType::ValueType >  )

This class requires OutputPixelShouldHaveBracketOperator in the form of ( Concept::BracketOperator< OutputPixelType, unsigned int, typename OutputPixelType::ValueType > )

Member Data Documentation

template<typename TInputImage , class TLabelImage , typename TOutputImage >
LabelPixelType itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::m_BackgroundValue [private]

Definition at line 149 of file itkLabelOverlayImageFilter.h.

template<typename TInputImage , class TLabelImage , typename TOutputImage >
double itk::LabelOverlayImageFilter< TInputImage, TLabelImage, TOutputImage >::m_Opacity [private]

Definition at line 148 of file itkLabelOverlayImageFilter.h.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 00:47:53 for ITK by doxygen 1.7.6.1