Base class for filters that take an image as input and overwrite that image as the output. More...

#include <itkInPlaceImageFilter.h>

Inherits itk::ImageToImageFilter< TInputImage, TOutputImage >.

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef Superclass::OutputImageType	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef InPlaceImageFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
Public Member Functions
virtual bool	CanRunInPlace () const
virtual const char *	GetNameOfClass () const

virtual void	SetInPlace (bool _arg)
virtual bool	GetInPlace () const
virtual void	InPlaceOn ()
virtual void	InPlaceOff ()
Static Public Attributes

static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Member Functions
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Private Member Functions
	InPlaceImageFilter (const Self &)
void	InternalAllocateOutputs (const TrueType &)
void	InternalAllocateOutputs (const FalseType &)
void	operator= (const Self &)
Private Attributes
bool	m_InPlace
bool	m_RunningInPlace

Detailed Description

template<class TInputImage, class TOutputImage = TInputImage>
class itk::InPlaceImageFilter< TInputImage, TOutputImage >

Base class for filters that take an image as input and overwrite that image as the output.

InPlaceImageFilter 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. InPlaceImageFilters 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 InPlaceImageFilter 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. Additionally, the requested region of the output must match that of the input. In place operation can also be controlled (when the input and output image type match) via the methods InPlaceOn() and InPlaceOff().

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

Definition at line 72 of file itkInPlaceImageFilter.h.