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

#include <itkRecursiveSeparableImageFilter.h>

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

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

Detailed Description

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

Base class for recursive convolution with a kernel.

RecursiveSeparableImageFilter is the base class for recursive filters that are applied in each dimension separately. If multi-component images are specified, the filtering operation works on each component independently.

This class implements the recursive filtering method proposed by R.Deriche in IEEE-PAMI Vol.12, No.1, January 1990, pp 78-87.

Details of the implementation are described in the technical report: R. Deriche, "Recursively Implementing The Gaussian and Its Derivatives", INRIA, 1993, ftp://ftp.inria.fr/INRIA/tech-reports/RR/RR-1893.ps.gz

Further improvements of the algorithm are described in: G. Farneback & C.-F. Westin, "On Implementation of Recursive Gaussian Filters", so far unpublished.

Definition at line 51 of file itkRecursiveSeparableImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::ConstPointer	InputImageConstPointer
typedef TInputImage::Pointer	InputImagePointer
typedef TInputImage	InputImageType
typedef TInputImage::PixelType	InputPixelType
typedef TOutputImage::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef NumericTraits < InputPixelType >::RealType	RealType
typedef NumericTraits < InputPixelType > ::ScalarRealType	ScalarRealType
typedef RecursiveSeparableImageFilter	Self
typedef InPlaceImageFilter < TInputImage, TOutputImage >	Superclass
Public Types inherited from itk::InPlaceImageFilter< 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::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 unsigned int	GetDirection () const
const TInputImage *	GetInputImage (void)
virtual const char *	GetNameOfClass () const
virtual void	SetDirection (unsigned int _arg)
void	SetInputImage (const TInputImage *)
Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () 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)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual const bool &	GetAbortGenerateData ()
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 ()
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	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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
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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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

Protected Member Functions
void	BeforeThreadedGenerateData ()
void	EnlargeOutputRequestedRegion (DataObject *output)
void	FilterDataArray (RealType *outs, const RealType *data, RealType *scratch, unsigned int ln)
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const
void	PrintSelf (std::ostream &os, Indent indent) const
	RecursiveSeparableImageFilter ()
virtual void	SetUp (ScalarRealType spacing)=0
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~RecursiveSeparableImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
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	GenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
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 ()
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 ()
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 ()

Protected Attributes
ScalarRealType	m_BM1
ScalarRealType	m_BM2
ScalarRealType	m_BM3
ScalarRealType	m_BM4
ScalarRealType	m_BN1
ScalarRealType	m_BN2
ScalarRealType	m_BN3
ScalarRealType	m_BN4
ScalarRealType	m_D1
ScalarRealType	m_D2
ScalarRealType	m_D3
ScalarRealType	m_D4
ScalarRealType	m_M1
ScalarRealType	m_M2
ScalarRealType	m_M3
ScalarRealType	m_M4
ScalarRealType	m_N0
ScalarRealType	m_N1
ScalarRealType	m_N2
ScalarRealType	m_N3

Private Member Functions
void	operator= (const Self &)
	RecursiveSeparableImageFilter (const Self &)

Private Attributes
unsigned int	m_Direction
ImageRegionSplitterDirection::Pointer	m_ImageRegionSplitter

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 Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Member Typedef Documentation

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Definition at line 59 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

typedef TInputImage::ConstPointer itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImageConstPointer

Definition at line 66 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

typedef TInputImage::Pointer itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputImagePointer

Smart pointer typedef support.

Definition at line 62 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Type of the input image

Definition at line 80 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

typedef TInputImage::PixelType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::InputPixelType

Real type to be used in internal computations. RealType in general is templated over the pixel type. (For example for vector or tensor pixels, RealType is a vector or a tensor of doubles.) ScalarRealType is a type meant for scalars.

Definition at line 73 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

typedef TOutputImage::RegionType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::OutputImageRegionType

Definition at line 77 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Type of the output image

Definition at line 83 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Definition at line 58 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

typedef NumericTraits< InputPixelType >::RealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::RealType

Definition at line 74 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

typedef NumericTraits< InputPixelType >::ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::ScalarRealType

Definition at line 75 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Standard class typedefs.

Definition at line 56 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

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

Definition at line 57 of file itkRecursiveSeparableImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage = TInputImage>

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

protected

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::~RecursiveSeparableImageFilter ( )

inlineprotectedvirtual

Definition at line 99 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

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

private

Member Function Documentation

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData ( )

protectedvirtual

GenerateData (apply) the filter.

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::EnlargeOutputRequestedRegion ( DataObject *  output )

protectedvirtual

RecursiveSeparableImageFilter needs all of the input only in the "Direction" dimension. Therefore we enlarge the output's RequestedRegion to this. Then the superclass's GenerateInputRequestedRegion method will copy the output region to the input.

See Also

ImageToImageFilter::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::FilterDataArray ( RealType *  outs, const RealType *  data, RealType *  scratch, unsigned int  ln  )

protected

Apply the Recursive Filter to an array of data. This method is called for each line of the volume. Parameter "scratch" is a scratch area used for internal computations that is the same size as the parameters "outs" and "data". The scratch area must be allocated outside of this routine (this avoids memory allocation and deallocation in the inner loop of the overall algorithm.

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual unsigned int itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GetDirection ( ) const

virtual

Get the direction in which the filter is to be applied.

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual const ImageRegionSplitterBase* itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GetImageRegionSplitter ( void  ) const

protectedvirtual

Get the image splitter to split the image for multi-threading.

The Splitter object divides the image into regions for threading or streaming. The algorithms on how to split an images are separated into class so that they can be easily be reused. When deriving from this class to write a filter consideration to the algorithm used to divide the image should be made. If a change is desired this method should be overridden to return the appropriate object.

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , typename TOutputImage = TInputImage>

const TInputImage* itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::GetInputImage

(

void

)

Get Input Image.

template<typename TInputImage , typename TOutputImage = TInputImage>

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

virtual

Type macro that defines a name for this class.

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

Reimplemented in itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage = TInputImage>

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

private

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveSeparableImageFilter< 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::InPlaceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::SetDirection ( unsigned int  _arg )

virtual

Set the direction in which the filter is to be applied.

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::SetInputImage

(

const TInputImage *

)

Set Input Image.

template<typename TInputImage , typename TOutputImage = TInputImage>

virtual void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::SetUp ( ScalarRealType  spacing )

protectedpure virtual

Set up the coefficients of the filter to approximate a specific kernel. Typically it can be used to approximate a Gaussian or one of its derivatives. Parameter is the spacing along the dimension to filter.

Implemented in itk::RecursiveGaussianImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TOutputImage = TInputImage>

void itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType &  outputRegionForThread, ThreadIdType  threadId  )

protectedvirtual

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::ImageSource< TOutputImage >.

Member Data Documentation

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BM1

protected

Definition at line 163 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BM2

protected

Definition at line 164 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BM3

protected

Definition at line 165 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BM4

protected

Definition at line 166 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BN1

protected

Recursive coefficients to be used at the boundaries to simulate edge extension boundary conditions.

Definition at line 158 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BN2

protected

Definition at line 159 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BN3

protected

Definition at line 160 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_BN4

protected

Definition at line 161 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_D1

protected

Recursive coefficients that multiply previously computed values at the output. These are the same for the causal and anti-causal parts of the filter.

Definition at line 145 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_D2

protected

Definition at line 146 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_D3

protected

Definition at line 147 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_D4

protected

Definition at line 148 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

unsigned int itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_Direction

private

Direction in which the filter is to be applied this should be in the range [0,ImageDimension-1].

Definition at line 174 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ImageRegionSplitterDirection::Pointer itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_ImageRegionSplitter

private

Definition at line 176 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_M1

protected

Anti-causal coefficients that multiply the input data.

Definition at line 151 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_M2

protected

Definition at line 152 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_M3

protected

Definition at line 153 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_M4

protected

Definition at line 154 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_N0

protected

Causal coefficients that multiply the input data.

Definition at line 137 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_N1

protected

Definition at line 138 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_N2

protected

Definition at line 139 of file itkRecursiveSeparableImageFilter.h.

template<typename TInputImage , typename TOutputImage = TInputImage>

ScalarRealType itk::RecursiveSeparableImageFilter< TInputImage, TOutputImage >::m_N3

protected

Definition at line 140 of file itkRecursiveSeparableImageFilter.h.

---

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

• itkRecursiveSeparableImageFilter.h