ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput > Class Template Reference

#include <itkFFTImageFilterFactory.h>

Detailed Description

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
class itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >

Object factory implementation for FFT filters.

ITK FFT filters are designed for overridable implementation through the global ITK object factory singleton. In order to instantiate a base FFT image filter object, at least one valid implementation must be registered in the object factory.

FFTImageFilterFactory exists as an implementation detail designed to reduce overhead for FFT factory operations. A factory object templated over an FFT image filter implementation class will make constructor overrides for that class available through the global object factory singleton.

FFTImageFilterFactory can be used for making an FFT implementation class available through object factory initialization if the class meets certain criteria:

TInput and TOutput must be classes implementing the itk::Image interface but need not inherit from itk::Image. For example, an FFT filter could define operations over an itk::SpecialCoordinatesImage.

FFT filters not meeting these criteria may define an independent factory tailored to their particular instantiation requirements.

See also
FFTImageFilterTraits
VnlFFTImageFilterInitFactory

Definition at line 89 of file itkFFTImageFilterFactory.h.

+ Inheritance diagram for itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >:
+ Collaboration diagram for itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = FFTImageFilterFactory
 
using Superclass = ObjectFactoryBase
 
- Public Types inherited from itk::ObjectFactoryBase
using ConstPointer = SmartPointer< const Self >
 
using InsertionPositionEnum = ObjectFactoryEnums::InsertionPosition
 
using Pointer = SmartPointer< Self >
 
using Self = ObjectFactoryBase
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

 itkOverrideGetNameOfClassMacro (FFTImageFilterFactory)
 
const char * GetITKSourceVersion () const override
 
const char * GetDescription () const override
 
- Public Member Functions inherited from itk::ObjectFactoryBase
virtual void Disable (const char *className)
 
virtual std::list< std::string > GetClassOverrideDescriptions ()
 
virtual std::list< std::string > GetClassOverrideNames ()
 
virtual std::list< std::string > GetClassOverrideWithNames ()
 
virtual bool GetEnableFlag (const char *className, const char *subclassName)
 
virtual std::list< bool > GetEnableFlags ()
 
const char * GetLibraryPath ()
 
 itkOverrideGetNameOfClassMacro (ObjectFactoryBase)
 
virtual void SetEnableFlag (bool flag, const char *className, const char *subclassName)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
static void RegisterOneFactory ()
 
- Static Public Member Functions inherited from itk::ObjectFactoryBase
static std::list< LightObject::PointerCreateAllInstance (const char *itkclassname)
 
static LightObject::Pointer CreateInstance (const char *itkclassname)
 
static std::list< ObjectFactoryBase * > GetRegisteredFactories ()
 
static void Initialize ()
 
static void RegisterFactoryInternal (ObjectFactoryBase *)
 
template<typename TFactory >
static void RegisterInternalFactoryOnce ()
 
static void ReHash ()
 
static void UnRegisterAllFactories ()
 
static void UnRegisterFactory (ObjectFactoryBase *)
 
static bool RegisterFactory (ObjectFactoryBase *, InsertionPositionEnum where=InsertionPositionEnum::INSERT_AT_BACK, vcl_size_t position=0)
 
static void SetStrictVersionChecking (bool)
 
static void StrictVersionCheckingOn ()
 
static void StrictVersionCheckingOff ()
 
static bool GetStrictVersionChecking ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 FFTImageFilterFactory ()
 
template<typename InputPixelType , typename OutputPixelType , unsigned int D, unsigned int... ImageDimensions>
void OverrideFFTImageFilterType (const std::integer_sequence< unsigned int, D, ImageDimensions... > &)
 
template<typename InputPixelType , typename OutputPixelType >
void OverrideFFTImageFilterType (const std::integer_sequence< unsigned int > &)
 
- Protected Member Functions inherited from itk::ObjectFactoryBase
virtual std::list< LightObject::PointerCreateAllObject (const char *itkclassname)
 
virtual LightObject::Pointer CreateObject (const char *itkclassname)
 
 ObjectFactoryBase ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void RegisterOverride (const char *classOverride, const char *subclass, const char *description, bool enableFlag, CreateObjectFunctionBase *createFunction)
 
 ~ObjectFactoryBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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 ()
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
using itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::ConstPointer = SmartPointer<const Self>

Definition at line 97 of file itkFFTImageFilterFactory.h.

◆ Pointer

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
using itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::Pointer = SmartPointer<Self>

Definition at line 96 of file itkFFTImageFilterFactory.h.

◆ Self

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
using itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::Self = FFTImageFilterFactory

Definition at line 94 of file itkFFTImageFilterFactory.h.

◆ Superclass

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
using itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::Superclass = ObjectFactoryBase

Definition at line 95 of file itkFFTImageFilterFactory.h.

Constructor & Destructor Documentation

◆ FFTImageFilterFactory()

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::FFTImageFilterFactory ( )
inlineprotected

Definition at line 152 of file itkFFTImageFilterFactory.h.

Member Function Documentation

◆ GetDescription()

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
const char* itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::GetDescription ( ) const
inlineoverridevirtual

Class methods used to interface with the registered factories.

Implements itk::ObjectFactoryBase.

Definition at line 106 of file itkFFTImageFilterFactory.h.

◆ GetITKSourceVersion()

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
const char* itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::GetITKSourceVersion ( ) const
inlineoverridevirtual

Class methods used to interface with the registered factories.

Implements itk::ObjectFactoryBase.

Definition at line 101 of file itkFFTImageFilterFactory.h.

References ITK_SOURCE_VERSION.

◆ itkOverrideGetNameOfClassMacro()

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::itkOverrideGetNameOfClassMacro ( FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >  )

Run-time type information (and related methods).

◆ New()

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
static Pointer itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::New ( )
static

◆ OverrideFFTImageFilterType() [1/2]

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
template<typename InputPixelType , typename OutputPixelType >
void itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::OverrideFFTImageFilterType ( const std::integer_sequence< unsigned int > &  )
inlineprotected

Override base FFT image filter constructor with the given TFFTImageFilter template with distinct specialization. Requires TFFTImageFilter to have the template signature <InputImageType, OutputImageType>.

Definition at line 148 of file itkFFTImageFilterFactory.h.

◆ OverrideFFTImageFilterType() [2/2]

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
template<typename InputPixelType , typename OutputPixelType , unsigned int D, unsigned int... ImageDimensions>
void itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::OverrideFFTImageFilterType ( const std::integer_sequence< unsigned int, D, ImageDimensions... > &  )
inlineprotected

Override base FFT image filter constructor with the given TFFTImageFilter template with distinct specialization. Requires TFFTImageFilter to have the template signature <InputImageType, OutputImageType>.

Definition at line 134 of file itkFFTImageFilterFactory.h.

References itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::New(), and itk::ObjectFactoryBase::RegisterOverride().

◆ RegisterOneFactory()

template<template< typename, typename > class TFFTImageFilter, template< typename, unsigned int > class TInput = Image, template< typename, unsigned int > class TOutput = Image>
static void itk::FFTImageFilterFactory< TFFTImageFilter, TInput, TOutput >::RegisterOneFactory ( )
inlinestatic

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