Base class for filters that takes an image as input and overwrites that image as the output. More...

#include <itkInPlaceLabelMapFilter.h>

Inheritance diagram for itk::InPlaceLabelMapFilter< TInputImage >:

Collaboration diagram for itk::InPlaceLabelMapFilter< TInputImage >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::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 Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OutputImageType	OutputImageType
typedef InputImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef InputImageType::RegionType	RegionType
typedef InPlaceLabelMapFilter	Self
typedef LabelMapFilter < TInputImage, TInputImage >	Superclass
typedef TInputImage	TOutputImage
Public Member Functions
bool	CanRunInPlace () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const

virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace ()
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
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	AllocateOutputs ()
virtual InputImageType *	GetLabelMap ()
	InPlaceLabelMapFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	~InPlaceLabelMapFilter ()
Private Member Functions
	InPlaceLabelMapFilter (const Self &)
void	operator= (const Self &)
Private Attributes
bool	m_InPlace

Detailed Description

template<class TInputImage>
class itk::InPlaceLabelMapFilter< TInputImage >

Base class for filters that takes an image as input and overwrites that image as the output.

InPlaceLabelMapFilter is the base class for all process objects whose output image data is constructed by overwriting the input image data. In other words, the output bulk data is the same block of memory as the input bulk data. This filter provides the mechanisms for in place image processing while maintaining general pipeline mechanics. InPlaceLabelMapFilters use less memory than standard ImageToImageFilters because the input buffer is reused as the output buffer. However, this benefit does not come without a cost. Since the filter overwrites its input, the ownership of the bulk data is transitioned from the input data object to the output data object. When a data object has multiple consumers with one of the consumers being an in place filter, the in place filter effectively destroys the bulk data for the data object. Upstream filters will then have to re-execute to regenerate the data object's bulk data for the remaining consumers.

Since an InPlaceLabelMapFilter reuses the input bulk data memory for the output bulk data memory, the input image type must match the output image type. If the input and output image types are not identical, the filter reverts to a traditional ImageToImageFilter behaviour where an output image is allocated. In place operation can also be controlled (when the input and output image type match) via the methods InPlaceOn() and InPlaceOff().

Subclasses of InPlaceLabelMapFilter must take extra care in how they manage memory using (and perhaps overriding) the implementations of ReleaseInputs() and AllocateOutputs() provided here.

This code was contributed in the Insight Journal paper: "Label object representation and manipulation with ITK" by Lehmann G. http://hdl.handle.net/1926/584 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:: LabelMapToBinaryImageFilter, LabelMapToLabelImageFilter

Definition at line 83 of file itkInPlaceLabelMapFilter.h.

Member Typedef Documentation

template<class TInputImage>

typedef SmartPointer< const Self > itk::InPlaceLabelMapFilter< TInputImage >::ConstPointer

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

Definition at line 90 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InputImageType::IndexType itk::InPlaceLabelMapFilter< TInputImage >::IndexType

Definition at line 113 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InputImageType::ConstPointer itk::InPlaceLabelMapFilter< TInputImage >::InputImageConstPointer

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 107 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InputImageType::PixelType itk::InPlaceLabelMapFilter< TInputImage >::InputImagePixelType

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 109 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InputImageType::Pointer itk::InPlaceLabelMapFilter< TInputImage >::InputImagePointer

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 106 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InputImageType::RegionType itk::InPlaceLabelMapFilter< TInputImage >::InputImageRegionType

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 108 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef TInputImage itk::InPlaceLabelMapFilter< TInputImage >::InputImageType

Some convenient typedefs.

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 105 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InputImageType::LabelObjectType itk::InPlaceLabelMapFilter< TInputImage >::LabelObjectType

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

Definition at line 110 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef Superclass::OutputImagePixelType itk::InPlaceLabelMapFilter< TInputImage >::OutputImagePixelType

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 102 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef Superclass::OutputImagePointer itk::InPlaceLabelMapFilter< TInputImage >::OutputImagePointer

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 100 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef Superclass::OutputImageRegionType itk::InPlaceLabelMapFilter< TInputImage >::OutputImageRegionType

Superclass typedefs.

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 101 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef Superclass::OutputImageType itk::InPlaceLabelMapFilter< TInputImage >::OutputImageType

Superclass typedefs.

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

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 96 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InputImageType::PixelType itk::InPlaceLabelMapFilter< TInputImage >::PixelType

Definition at line 112 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef SmartPointer< Self > itk::InPlaceLabelMapFilter< TInputImage >::Pointer

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

Definition at line 89 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InputImageType::RegionType itk::InPlaceLabelMapFilter< TInputImage >::RegionType

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, itk::RegionFromReferenceLabelMapFilter< TInputImage >, itk::ShapeLabelMapFilter< TImage, TLabelImage >, and itk::ShapeLabelMapFilter< TImage, Image< TImage::PixelType,::itk::GetImageDimension< TImage >::ImageDimension > >.

Definition at line 114 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef InPlaceLabelMapFilter itk::InPlaceLabelMapFilter< TInputImage >::Self

Standard class typedefs.

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

Definition at line 87 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef LabelMapFilter< TInputImage, TInputImage > itk::InPlaceLabelMapFilter< TInputImage >::Superclass

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

Definition at line 88 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

typedef TInputImage itk::InPlaceLabelMapFilter< TInputImage >::TOutputImage

Reimplemented in itk::AutoCropLabelMapFilter< TInputImage >, itk::ChangeRegionLabelMapFilter< TInputImage >, itk::CropLabelMapFilter< TInputImage >, itk::PadLabelMapFilter< TInputImage >, and itk::RegionFromReferenceLabelMapFilter< TInputImage >.

Definition at line 116 of file itkInPlaceLabelMapFilter.h.

Constructor & Destructor Documentation

template<class TInputImage>

itk::InPlaceLabelMapFilter< TInputImage >::InPlaceLabelMapFilter ( ) [protected]

template<class TInputImage>

itk::InPlaceLabelMapFilter< TInputImage >::~InPlaceLabelMapFilter ( ) [protected]

template<class TInputImage>

itk::InPlaceLabelMapFilter< TInputImage >::InPlaceLabelMapFilter ( const Self & ) [private]

Member Function Documentation

template<class TInputImage>

virtual void itk::InPlaceLabelMapFilter< TInputImage >::AllocateOutputs ( ) [protected, virtual]

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceLabelMapFilter's can use an overwritten version of the input for its output, the output buffer should not be allocated. When possible, we graft the input to the filter to the output. If an InPlaceFilter has multiple outputs, then it would need to override this method to graft one of its outputs and allocate the remaining. If a filter is threaded (i.e. it provides an implementation of ThreadedGenerateData()), this method is called automatically. If an InPlaceFilter is not threaded (i.e. it provides an implementation of GenerateData()), then this method (or equivalent) must be called in GenerateData().

Reimplemented from itk::ImageSource< TInputImage >.

template<class TInputImage>

bool itk::InPlaceLabelMapFilter< TInputImage >::CanRunInPlace ( ) const [inline]

Can the filter run in place? To do so, the filter's first input and output must have the same dimension and pixel type. This method can be used in conjunction with the InPlace ivar to determine whether a particular use of the filter is really running in place. Some filters may be able to optimize their operation if the InPlace is true and CanRunInPlace is true.

Definition at line 136 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

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

template<class TInputImage>

virtual bool itk::InPlaceLabelMapFilter< TInputImage >::GetInPlace ( ) [virtual]

In place operation can be turned on and off. This only has an effect when the input and output image type match.

template<class TInputImage>

virtual InputImageType* itk::InPlaceLabelMapFilter< TInputImage >::GetLabelMap ( ) [inline, protected, virtual]

Return the output label collection image, instead of the input as in the default implementation

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

Definition at line 169 of file itkInPlaceLabelMapFilter.h.

template<class TInputImage>

virtual const char* itk::InPlaceLabelMapFilter< TInputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

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

template<class TInputImage>

virtual void itk::InPlaceLabelMapFilter< TInputImage >::InPlaceOff ( ) [virtual]

In place operation can be turned on and off. This only has an effect when the input and output image type match.

template<class TInputImage>

virtual void itk::InPlaceLabelMapFilter< TInputImage >::InPlaceOn ( ) [virtual]

In place operation can be turned on and off. This only has an effect when the input and output image type match.

template<class TInputImage>

static Pointer itk::InPlaceLabelMapFilter< TInputImage >::New ( ) [static]

Standard New method.

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

template<class TInputImage>

void itk::InPlaceLabelMapFilter< TInputImage >::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, TInputImage >.

template<class TInputImage>

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