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

#include <itkLabelMapMaskImageFilter.h>

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

Collaboration diagram for itk::LabelMapMaskImageFilter< 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 LabelObjectType::LabelType	LabelType
typedef LabelObjectType::LengthType	LengthType
typedef OutputImageType::ConstPointer	OutputImageConstPointer
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef OutputImageType::RegionType	RegionType
typedef LabelMapMaskImageFilter	Self
typedef OutputImageType::SizeType	SizeType
typedef LabelMapFilter < TInputImage, TOutputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const OutputImageType *	GetFeatureImage ()
virtual const char *	GetNameOfClass () const
void	SetFeatureImage (const TOutputImage *input)
void	SetInput1 (const TInputImage *input)
void	SetInput2 (const TOutputImage *input)
virtual void	SetBackgroundValue (OutputImagePixelType _arg)
virtual OutputImagePixelType	GetBackgroundValue () const
virtual void	SetLabel (InputImagePixelType _arg)
virtual InputImagePixelType	GetLabel () const
virtual void	SetNegated (bool _arg)
virtual const bool &	GetNegated ()
virtual void	NegatedOn ()
virtual void	NegatedOff ()
virtual void	SetCrop (bool _arg)
virtual const bool &	GetCrop ()
virtual void	CropOn ()
virtual void	CropOff ()
virtual void	SetCropBorder (SizeType _arg)
virtual const SizeType &	GetCropBorder ()
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
static const unsigned int	ImageDimension = TOutputImage::ImageDimension
Protected Member Functions
virtual void	BeforeThreadedGenerateData ()
void	EnlargeOutputRequestedRegion (DataObject *)
void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
	LabelMapMaskImageFilter ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual void	ThreadedProcessLabelObject (LabelObjectType *labelObject)
	~LabelMapMaskImageFilter ()
Private Member Functions
	LabelMapMaskImageFilter (const Self &)
void	operator= (const Self &)
Private Attributes
OutputImagePixelType	m_BackgroundValue
Barrier::Pointer	m_Barrier
bool	m_Crop
SizeType	m_CropBorder
TimeStamp	m_CropTimeStamp
InputImagePixelType	m_Label
bool	m_Negated

---

Detailed Description

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

Mask and image with a LabelMap.

LabelMapMaskImageFilter mask the content of an input image according to the content of the input LabelMap. The masked pixel of the input image are set to the BackgroundValue. LabelMapMaskImageFilter can keep the input image for one label only, with Negated = false (the default) or it can mask the input image for a single label, when Negated equals true. In Both cases, the label is set with SetLabel().

Author:

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

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

See also:

LabelMapToBinaryImageFilter, LabelMapToLabelImageFilter

Definition at line 47 of file itkLabelMapMaskImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TOutputImage >

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

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

Definition at line 55 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 72 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 61 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 63 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 60 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 62 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Some convenient typedefs.

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

Definition at line 58 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 64 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef LabelObjectType::LabelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelType

Definition at line 65 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef LabelObjectType::LengthType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LengthType

Definition at line 66 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 69 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 71 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 68 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Superclass typedefs.

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

Definition at line 70 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Some convenient typedefs.

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

Definition at line 59 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 54 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::RegionType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::RegionType

Definition at line 74 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Standard class typedefs.

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

Definition at line 52 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

typedef OutputImageType::SizeType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SizeType

Definition at line 73 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

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

Definition at line 53 of file itkLabelMapMaskImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TOutputImage >

itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelMapMaskImageFilter

(

)

[protected]

template<class TInputImage , class TOutputImage >

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

(

)

[inline, protected]

Definition at line 159 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::LabelMapMaskImageFilter

(

const Self &

)

[private]

---

Member Function Documentation

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< 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::LabelMapMaskImageFilter< 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 >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::CropOff

(

)

[virtual]

Set/Get whether the image size should be adjusted to the masked image or not.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::CropOn

(

)

[virtual]

Set/Get whether the image size should be adjusted to the masked image or not.

template<class TInputImage , class TOutputImage >

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

(

DataObject *

)

[protected, virtual]

LabelMapMaskImageFilter will produce the entire output.

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

template<class TInputImage , class TOutputImage >

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

(

)

[protected, virtual]

LabelMapMaskImageFilter 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 >

virtual void itk::LabelMapMaskImageFilter< TInputImage, 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::ProcessObject.

template<class TInputImage , class TOutputImage >

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

(

)

const [virtual]

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

template<class TInputImage , class TOutputImage >

virtual const bool& itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetCrop

(

)

[virtual]

Set/Get whether the image size should be adjusted to the masked image or not.

template<class TInputImage , class TOutputImage >

virtual const SizeType& itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetCropBorder

(

)

[virtual]

Set/Get the boder added to the mask before the crop. The default is 0 on all the axes.

template<class TInputImage , class TOutputImage >

const OutputImageType* itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetFeatureImage

(

)

[inline]

Get the feature image

Definition at line 101 of file itkLabelMapMaskImageFilter.h.

References itk::ProcessObject::GetInput().

template<class TInputImage , class TOutputImage >

virtual InputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetLabel

(

)

const [virtual]

The label to mask or to not mask, depending on the value of the Negated ivar.

template<class TInputImage , class TOutputImage >

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

(

)

const [virtual]

Runtime information support.

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

template<class TInputImage , class TOutputImage >

virtual const bool& itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::GetNegated

(

)

[virtual]

Set/Get whether the Label should be masked or not.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::NegatedOff

(

)

[virtual]

Set/Get whether the Label should be masked or not.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::NegatedOn

(

)

[virtual]

Set/Get whether the Label should be masked or not.

template<class TInputImage , class TOutputImage >

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

(

)

[static]

Standard New method.

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

template<class TInputImage , class TOutputImage >

void itk::LabelMapMaskImageFilter< 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::LabelMapMaskImageFilter< 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 >

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

(

OutputImagePixelType

_arg

)

[virtual]

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

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetCrop

(

bool

_arg

)

[virtual]

Set/Get whether the image size should be adjusted to the masked image or not.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetCropBorder

(

SizeType

_arg

)

[virtual]

Set/Get the boder added to the mask before the crop. The default is 0 on all the axes.

template<class TInputImage , class TOutputImage >

void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetFeatureImage

(

const TOutputImage *

input

)

[inline]

Set the feature image

Definition at line 94 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

(

const TInputImage *

input

)

[inline]

Set the input image

Definition at line 107 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

(

const TOutputImage *

input

)

[inline]

Set the feature image

Definition at line 113 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetLabel

(

InputImagePixelType

_arg

)

[virtual]

The label to mask or to not mask, depending on the value of the Negated ivar.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::SetNegated

(

bool

_arg

)

[virtual]

Set/Get whether the Label should be masked or not.

template<class TInputImage , class TOutputImage >

virtual void itk::LabelMapMaskImageFilter< 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::LabelMapMaskImageFilter< 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::LabelMapMaskImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constants

Definition at line 83 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

ImageDimension constants

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

Definition at line 79 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 184 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

Definition at line 191 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

bool itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Crop [private]

Definition at line 186 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

SizeType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_CropBorder [private]

Definition at line 187 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

TimeStamp itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_CropTimeStamp [private]

Definition at line 189 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

InputImagePixelType itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Label [private]

Definition at line 183 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

bool itk::LabelMapMaskImageFilter< TInputImage, TOutputImage >::m_Negated [private]

Definition at line 185 of file itkLabelMapMaskImageFilter.h.

template<class TInputImage , class TOutputImage >

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

ImageDimension constants

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

Definition at line 81 of file itkLabelMapMaskImageFilter.h.

---

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

• itkLabelMapMaskImageFilter.h