ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter > Class Template Reference

#include <itkMiniPipelineSeparableImageFilter.h>

+ Inheritance diagram for itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >:
+ Collaboration diagram for itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >:

List of all members.

Public Types

typedef CastImageFilter
< InputImageType,
OutputImageType
CastType
typedef SmartPointer< const SelfConstPointer
typedef TFilter FilterType
typedef TInputImage::IndexType IndexType
typedef TInputImage InputImageType
typedef TInputImage::OffsetType OffsetType
typedef TOutputImage OutputImageType
typedef TOutputImage::PixelType OutputPixelType
typedef TInputImage::PixelType PixelType
typedef SmartPointer< SelfPointer
typedef TInputImage::SizeType RadiusType
typedef TInputImage::RegionType RegionType
typedef
MiniPipelineSeparableImageFilter 
Self
typedef TInputImage::SizeType SizeType
typedef BoxImageFilter
< TInputImage, TOutputImage > 
Superclass
- Public Types inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
typedef TInputImage::PixelType InputPixelType
typedef TInputImage::SizeValueType RadiusValueType
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef
InputImageType::ConstPointer 
InputImageConstPointer
typedef InputImageType::PixelType InputImagePixelType
typedef InputImageType::Pointer InputImagePointer
typedef InputImageType::RegionType InputImageRegionType
typedef
Superclass::OutputImagePixelType 
OutputImagePixelType
typedef
Superclass::OutputImageRegionType 
OutputImageRegionType
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
typedef OutputImageType::Pointer OutputImagePointer
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
virtual void Modified () const
virtual void SetNumberOfThreads (ThreadIdType nb)
virtual void SetRadius (const RadiusType &)
virtual void SetRadius (const SizeValueType &radius)
- Public Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
void GenerateInputRequestedRegion ()
virtual const RadiusTypeGetRadius ()
virtual void SetRadius (const RadiusValueType &radius)
- Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageTypeGetInput (void) const
const InputImageTypeGetInput (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)
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageTypeGetOutput (void)
const OutputImageTypeGetOutput (void) const
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual void EnlargeOutputRequestedRegion (DataObject *)
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 const ThreadIdTypeGetNumberOfThreads ()
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) 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

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TInputImage::ImageDimension
- Static Public Attributes inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
- 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 >

Protected Member Functions

void GenerateData ()
 MiniPipelineSeparableImageFilter ()
 ~MiniPipelineSeparableImageFilter ()
- Protected Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
 BoxImageFilter ()
void PrintSelf (std::ostream &os, Indent indent) const
 ~BoxImageFilter ()
- 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)
 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 AllocateOutputs ()
virtual void BeforeThreadedGenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, 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)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateOutputInformation ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
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 SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () 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

CastType::Pointer m_Cast
FilterType::Pointer m_Filters [ImageDimension]

Private Member Functions

 MiniPipelineSeparableImageFilter (const Self &)
void operator= (const Self &)

Detailed Description

template<class TInputImage, class TOutputImage, class TFilter>
class itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >

A separable filter for filter which are using radius.

This filter takes a non separable implementation of a neighborhood filter, and run it several times (one per dimension) to implement the same separable transform. This filter can be used with the filter for which the neighborhood is defined by the SetRadius() method, like the BoxImageFilter and its subcalsses.

This code was contributed in the Insight Journal paper: "Efficient implementation of kernel filtering" by Beare R., Lehmann G http://hdl.handle.net/1926/555 http://www.insight-journal.org/browse/publication/160

Author:
Gaetan Lehmann
Richard Beare

Definition at line 50 of file itkMiniPipelineSeparableImageFilter.h.


Member Typedef Documentation

template<class TInputImage, class TOutputImage, class TFilter>
typedef CastImageFilter< InputImageType, OutputImageType > itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::CastType

Definition at line 79 of file itkMiniPipelineSeparableImageFilter.h.

template<class TInputImage, class TOutputImage, class TFilter>
typedef SmartPointer< const Self > itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::ConstPointer
template<class TInputImage, class TOutputImage, class TFilter>
typedef TFilter itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::FilterType
template<class TInputImage, class TOutputImage, class TFilter>
typedef TInputImage::IndexType itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::IndexType
template<class TInputImage, class TOutputImage, class TFilter>
typedef TInputImage itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::InputImageType
template<class TInputImage, class TOutputImage, class TFilter>
typedef TInputImage::OffsetType itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::OffsetType
template<class TInputImage, class TOutputImage, class TFilter>
typedef TOutputImage itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::OutputImageType

Some convenient typedefs.

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

Definition at line 75 of file itkMiniPipelineSeparableImageFilter.h.

template<class TInputImage, class TOutputImage, class TFilter>
typedef TOutputImage::PixelType itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::OutputPixelType
template<class TInputImage, class TOutputImage, class TFilter>
typedef TInputImage::PixelType itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::PixelType
template<class TInputImage, class TOutputImage, class TFilter>
typedef SmartPointer< Self > itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::Pointer
template<class TInputImage, class TOutputImage, class TFilter>
typedef TInputImage::SizeType itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::RadiusType
template<class TInputImage, class TOutputImage, class TFilter>
typedef TInputImage::RegionType itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::RegionType
template<class TInputImage, class TOutputImage, class TFilter>
typedef MiniPipelineSeparableImageFilter itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::Self
template<class TInputImage, class TOutputImage, class TFilter>
typedef TInputImage::SizeType itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::SizeType
template<class TInputImage, class TOutputImage, class TFilter>
typedef BoxImageFilter< TInputImage, TOutputImage > itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::Superclass

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage, class TFilter>
itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::MiniPipelineSeparableImageFilter ( )
protected
template<class TInputImage, class TOutputImage, class TFilter>
itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::~MiniPipelineSeparableImageFilter ( )
inlineprotected

Definition at line 101 of file itkMiniPipelineSeparableImageFilter.h.

template<class TInputImage, class TOutputImage, class TFilter>
itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::MiniPipelineSeparableImageFilter ( const Self )
private

Member Function Documentation

template<class TInputImage, class TOutputImage, class TFilter>
virtual::itk::LightObject::Pointer itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::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::BoxImageFilter< TInputImage, TOutputImage >.

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

template<class TInputImage, class TOutputImage, class TFilter>
void itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::GenerateData ( )
protectedvirtual

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputImage, class TOutputImage, class TFilter>
virtual const char* itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::GetNameOfClass ( ) const
virtual
template<class TInputImage, class TOutputImage, class TFilter>
virtual void itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::Modified ( ) const
virtual

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage, class TFilter>
static Pointer itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::New ( )
static
template<class TInputImage, class TOutputImage, class TFilter>
void itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::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::BoxImageFilter< TInputImage, TOutputImage >.

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

template<class TInputImage, class TOutputImage, class TFilter>
virtual void itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::SetNumberOfThreads ( ThreadIdType  _arg)
virtual

Get/Set the number of threads to create when executing.

Reimplemented from itk::ProcessObject.

template<class TInputImage, class TOutputImage, class TFilter>
virtual void itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::SetRadius ( const RadiusType )
virtual
template<class TInputImage, class TOutputImage, class TFilter>
virtual void itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::SetRadius ( const SizeValueType radius)
inlinevirtual

Definition at line 89 of file itkMiniPipelineSeparableImageFilter.h.


Member Data Documentation

template<class TInputImage, class TOutputImage, class TFilter>
const unsigned int itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::ImageDimension = TInputImage::ImageDimension
static
template<class TInputImage, class TOutputImage, class TFilter>
CastType::Pointer itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::m_Cast
protected

Definition at line 106 of file itkMiniPipelineSeparableImageFilter.h.

template<class TInputImage, class TOutputImage, class TFilter>
FilterType::Pointer itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >::m_Filters[ImageDimension]
protected

Definition at line 105 of file itkMiniPipelineSeparableImageFilter.h.


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