#include <itkInPlaceImageFilter.h>

Inherits itk::ImageToImageFilter< TInputImage, TOutputImage >.

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

Detailed Description

template<typename TInputImage, typename 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.

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 Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
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::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

Public Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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 ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput (void) const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput (void)

const OutputImageType *	GetOutput (void) const

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) ITK_OVERRIDE

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

NameArray	GetInputNames () const

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

DataObjectPointerArray	GetInputs ()

DataObjectPointerArray	GetOutputs ()

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual LightObject::Pointer	CreateAnother () const ITK_OVERRIDE

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Attributes

static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
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 ()

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

virtual void	GenerateInputRequestedRegion ()

	ImageToImageFilter ()

virtual void	VerifyInputInformation ()

	~ImageToImageFilter ()

void	PushBackInput (const DataObject *input)

void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	BeforeThreadedGenerateData ()

virtual void	GenerateData () ITK_OVERRIDE

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)

virtual	~ImageSource ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

virtual void	AddOutput (DataObject *output)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

virtual void	VerifyPreconditions ()

	~ProcessObject ()

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	InPlaceImageFilter (const Self &)

void	InternalAllocateOutputs (const FalseType &)

void	InternalAllocateOutputs (const TrueType &)

void	operator= (const Self &)

Private Attributes
bool	m_InPlace

bool	m_RunningInPlace

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock

Member Typedef Documentation

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 79 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 93 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 95 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 92 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 94 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Some convenient typedefs.

Definition at line 91 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

typedef Superclass::OutputImagePixelType itk::InPlaceImageFilter< TInputImage, TOutputImage >::OutputImagePixelType

Definition at line 88 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

typedef Superclass::OutputImagePointer itk::InPlaceImageFilter< TInputImage, TOutputImage >::OutputImagePointer

Definition at line 86 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

typedef Superclass::OutputImageRegionType itk::InPlaceImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 87 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

typedef Superclass::OutputImageType itk::InPlaceImageFilter< TInputImage, TOutputImage >::OutputImageType

Superclass typedefs.

Definition at line 82 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Definition at line 78 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

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

Standard class typedefs.

Definition at line 76 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::InPlaceImageFilter< TInputImage, TOutputImage >::Superclass

Definition at line 77 of file itkInPlaceImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage, typename TOutputImage = TInputImage>

itk::InPlaceImageFilter< TInputImage, TOutputImage >::InPlaceImageFilter ( )

protected

template<typename TInputImage, typename TOutputImage = TInputImage>

itk::InPlaceImageFilter< TInputImage, TOutputImage >::~InPlaceImageFilter ( )

protected

template<typename TInputImage, typename TOutputImage = TInputImage>

itk::InPlaceImageFilter< TInputImage, TOutputImage >::InPlaceImageFilter ( const Self & )

private

Member Function Documentation

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::AllocateOutputs ( )

inlineprotectedvirtual

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Since InPlaceImageFilter'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< TOutputImage >.

Reimplemented in itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >.

Definition at line 142 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::CanRunInPlace ( ) const

virtual

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. CanRunInPlace may also be overridded by InPlaceImageFilter subclasses to fine tune its behavior.

Reimplemented in itk::SmoothingRecursiveGaussianImageFilter< TInputImage, TOutputImage >, and itk::SmoothingRecursiveYvvGaussianImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::GetInPlace ( ) const

virtual

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual const char* itk::InPlaceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::GetRunningInPlace ( ) const

protectedvirtual

This methods should only be called during the GenerateData phase of the pipeline. This method return true if the input image's bulk data is the same as the output image's data.

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::InPlaceOff ( )

virtual

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

Referenced by itk::RelabelComponentImageFilter< TInputImage, TOutputImage >::RelabelComponentImageFilter().

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::InPlaceOn ( )

virtual

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::InPlaceImageFilter< TInputImage, TOutputImage >::InternalAllocateOutputs ( const FalseType & )

inlineprivate

Definition at line 169 of file itkInPlaceImageFilter.h.

Referenced by itk::InPlaceImageFilter< TImage, TImage >::AllocateOutputs().

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::InPlaceImageFilter< TInputImage, TOutputImage >::InternalAllocateOutputs ( const TrueType & )

private

template<typename TInputImage, typename TOutputImage = TInputImage>

void itk::InPlaceImageFilter< TInputImage, TOutputImage >::operator= ( const Self & )

private

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtual

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

Referenced by itk::TensorRelativeAnisotropyImageFilter< TInputImage, TOutputImage >::PrintSelf(), itk::TensorFractionalAnisotropyImageFilter< TInputImage, TOutputImage >::PrintSelf(), itk::BinaryNotImageFilter< TImage >::PrintSelf(), and itk::SymmetricEigenAnalysisImageFilter< TInputImage, TOutputImage >::PrintSelf().

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::ReleaseInputs ( )

protectedvirtual

InPlaceImageFilter may transfer ownership of the input bulk data to the output object. Once the output object owns the bulk data (done in AllocateOutputs()), the input object must release its hold on the bulk data. ProcessObject::ReleaseInputs() only releases the input bulk data when the user has set the ReleaseDataFlag. InPlaceImageFilter::ReleaseInputs() also releases the input that it has overwritten.

See Also: ProcessObject::ReleaseInputs()

Reimplemented from itk::ProcessObject.

Reimplemented in itk::GPUInPlaceImageFilter< TInputImage, TOutputImage, BinaryThresholdImageFilter< TInputImage, TOutputImage > >.

template<typename TInputImage, typename TOutputImage = TInputImage>

virtual void itk::InPlaceImageFilter< TInputImage, TOutputImage >::SetInPlace ( bool _arg )

virtual

In place operation can be turned on and off. Asking for in-place operation, i.e. calling SetInplace(true) or InplaceOn(), will be effective only if CanRunInPlace also returns true. By default CanRunInPlace checks whether the input and output image type match.

Member Data Documentation

template<typename TInputImage, typename TOutputImage = TInputImage>

const unsigned int itk::InPlaceImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension

static

ImageDimension constants

Definition at line 99 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::m_InPlace

private

Definition at line 177 of file itkInPlaceImageFilter.h.

template<typename TInputImage, typename TOutputImage = TInputImage>

bool itk::InPlaceImageFilter< TInputImage, TOutputImage >::m_RunningInPlace

private

Definition at line 178 of file itkInPlaceImageFilter.h.

Referenced by itk::InPlaceImageFilter< TImage, TImage >::InternalAllocateOutputs().

template<typename TInputImage, typename TOutputImage = TInputImage>

const unsigned int itk::InPlaceImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

ImageDimension constants

Definition at line 101 of file itkInPlaceImageFilter.h.

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

itkInPlaceImageFilter.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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