itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage > Class Template Reference

Convert a LabelMap to a binary image. More...

#include <itkLabelMapToBinaryImageFilter.h>

Inheritance diagram for itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef OutputImageType::IndexType	IndexType
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef InputImageType::LabelObjectType	LabelObjectType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef LabelMapToBinaryImageFilter	Self
typedef LabelMapFilter < TInputImage, TOutputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
OutputImageType *	GetBackgroundImage ()
virtual const char *	GetNameOfClass () const
void	SetBackgroundImage (const OutputImageType *input)
void	SetInput1 (const InputImageType *input)
void	SetInput2 (const OutputImageType *input)
virtual void	SetBackgroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType	GetBackgroundValue () const
virtual void	SetForegroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType	GetForegroundValue () const
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Member Functions
virtual void	BeforeThreadedGenerateData ()
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateInputRequestedRegion ()
	LabelMapToBinaryImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject)
	~LabelMapToBinaryImageFilter ()
Private Member Functions
	LabelMapToBinaryImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
OutputImagePixelType	m_BackgroundValue
Barrier::Pointer	m_Barrier
OutputImagePixelType	m_ForegroundValue

---

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >

Convert a LabelMap to a binary image.

LabelMapToBinaryImageFilter to a binary image. All the objects in the image are used as foreground. The background values of the original binary image can be restored by passing this image to the filter with the SetBackgroundImage() method.

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:

LabelMapToLabelImageFilter, LabelMapMaskImageFilter

Definition at line 46 of file itkLabelMapToBinaryImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

typedef SmartPointer< const Self > itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::ConstPointer

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

Definition at line 54 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::IndexType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::IndexType

Definition at line 69 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::ConstPointer itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

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

Definition at line 60 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::PixelType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::InputImagePixelType

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

Definition at line 62 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::Pointer itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::InputImagePointer

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

Definition at line 59 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::RegionType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::InputImageRegionType

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

Definition at line 61 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TInputImage itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

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

Definition at line 57 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef InputImageType::LabelObjectType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::LabelObjectType

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

Definition at line 63 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::ConstPointer itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::OutputImageConstPointer

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

Definition at line 66 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::PixelType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

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

Definition at line 68 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::Pointer itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::OutputImagePointer

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

Definition at line 65 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Superclass typedefs.

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

Definition at line 67 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef TOutputImage itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::OutputImageType

Some convenient typedefs.

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

Definition at line 58 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef SmartPointer< Self > itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::Pointer

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

Definition at line 53 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef LabelMapToBinaryImageFilter itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::Self

Standard class typedefs.

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

Definition at line 51 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef LabelMapFilter< TInputImage, TOutputImage > itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::Superclass

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

Definition at line 52 of file itkLabelMapToBinaryImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::LabelMapToBinaryImageFilter

(

)

[protected]

template<class TInputImage , class TOutputImage >

itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::~LabelMapToBinaryImageFilter

(

)

[inline, protected]

Definition at line 125 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::LabelMapToBinaryImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData

(

void

)

[protected, virtual]

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::LabelMapFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

virtual::itk::LightObject::Pointer itk::LabelMapToBinaryImageFilter< TInputImage, 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::LabelMapFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion

(

DataObject *

)

[protected, virtual]

LabelMapToBinaryImageFilter will produce the entire output.

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

template<class TInputImage , class TOutputImage >

void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion

(

)

[protected, virtual]

LabelMapToBinaryImageFilter needs the entire input be available. Thus, it needs to provide an implementation of GenerateInputRequestedRegion().

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

template<class TInputImage , class TOutputImage >

OutputImageType* itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::GetBackgroundImage

(

)

[inline]

Definition at line 106 of file itkLabelMapToBinaryImageFilter.h.

References itk::ProcessObject::GetInput().

template<class TInputImage , class TOutputImage >

virtual OutputImagePixelType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::GetBackgroundValue

(

)

const [virtual]

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin().

template<class TInputImage , class TOutputImage >

virtual OutputImagePixelType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::GetForegroundValue

(

)

const [virtual]

Set/Get the value used as "foreground" in the output image. Defaults to NumericTraits<PixelType>::max().

template<class TInputImage , class TOutputImage >

virtual const char* itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::GetNameOfClass

(

)

const [virtual]

Runtime information support.

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

template<class TInputImage , class TOutputImage >

static Pointer itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::New

(

)

[static]

Standard New method.

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

template<class TInputImage , class TOutputImage >

void itk::LabelMapToBinaryImageFilter< TInputImage, 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::LabelMapFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

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::ImageToImageFilter< TInputImage, TOutputImage >.

template<class TInputImage , class TOutputImage >

void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::SetBackgroundImage

(

const OutputImageType *

input

)

[inline]

Set/Get the background image top be used to restore the background values

Definition at line 100 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::SetBackgroundValue

(

OutputImagePixelType

_arg

)

[virtual]

Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::NonpositiveMin().

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::SetForegroundValue

(

OutputImagePixelType

_arg

)

[virtual]

Set/Get the value used as "foreground" in the output image. Defaults to NumericTraits<PixelType>::max().

template<class TInputImage , class TOutputImage >

void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::SetInput1

(

const InputImageType *

input

)

[inline]

Set the input image

Definition at line 112 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::SetInput2

(

const OutputImageType *

input

)

[inline]

Set the marker image

Definition at line 118 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)		[protected, virtual]

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:

GenerateData(), SplitRequestedRegion()

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

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::ThreadedProcessLabelObject

(

LabelObjectType *

labelObject

)

[protected, virtual]

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

---

Member Data Documentation

template<class TInputImage , class TOutputImage >

const unsigned int itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 72 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

OutputImagePixelType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::m_BackgroundValue [private]

Definition at line 147 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

Barrier::Pointer itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::m_Barrier [private]

Definition at line 150 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

OutputImagePixelType itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::m_ForegroundValue [private]

Definition at line 148 of file itkLabelMapToBinaryImageFilter.h.

template<class TInputImage , class TOutputImage >

const unsigned int itk::LabelMapToBinaryImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constants

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

Definition at line 73 of file itkLabelMapToBinaryImageFilter.h.

---

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

• itkLabelMapToBinaryImageFilter.h