ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
itk::FFTWGlobalConfiguration Class Reference
Group Filtering » Module ITKFFT

#include <itkFFTWGlobalConfiguration.h>

Detailed Description

A class to contain all the global configuration options for FFTW.

A simple global lock is included that must be called before calling FFTW unsafe functions. It also handle cleanly the initialization and cleanup of FFTW.

This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/0iky0u

Author
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.
Hans Johnson, The University of Iowa

Definition at line 203 of file itkFFTWGlobalConfiguration.h.

+ Inheritance diagram for itk::FFTWGlobalConfiguration:
+ Collaboration diagram for itk::FFTWGlobalConfiguration:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using MutexType = std::mutex
 
using Pointer = SmartPointer< Self >
 
using Self = FFTWGlobalConfiguration
 
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

const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static std::mutex & GetLockMutex ()
 
static int GetPlanRigor ()
 
static std::string GetPlanRigorName (const int value)
 
static int GetPlanRigorValue (const std::string &name)
 
static std::string GetWisdomFileDefaultBaseName ()
 
static void SetPlanRigor (const int v)
 
static void SetPlanRigor (const std::string &name)
 
static void SetWisdomFilenameGenerator (WisdomFilenameGeneratorBase *wfg)
 
static void SetNewWisdomAvailable (const bool v)
 
static bool GetNewWisdomAvailable ()
 
static void SetReadWisdomCache (const bool v)
 
static bool GetReadWisdomCache ()
 
static void SetWriteWisdomCache (const bool v)
 
static bool GetWriteWisdomCache ()
 
static void SetWisdomCacheBase (const std::string &v)
 
static std::string GetWisdomCacheBase ()
 
static bool ImportWisdomFileDouble (const std::string &fname)
 
static bool ExportWisdomFileDouble (const std::string &fname)
 
static bool ImportWisdomFileFloat (const std::string &fname)
 
static bool ExportWisdomFileFloat (const std::string &fname)
 
static bool ImportDefaultWisdomFileDouble ()
 
static bool ExportDefaultWisdomFileDouble ()
 
static bool ImportDefaultWisdomFileFloat ()
 
static bool ExportDefaultWisdomFileFloat ()
 
static bool ImportDefaultWisdomFile ()
 
static bool ExportDefaultWisdomFile ()
 
- 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 ()
 

Private Member Functions

 FFTWGlobalConfiguration ()
 
 itkGetGlobalDeclarationMacro (FFTWGlobalConfigurationGlobals, PimplGlobals)
 
 ~FFTWGlobalConfiguration () override
 

Static Private Member Functions

static Pointer GetInstance ()
 
static Pointer New ()
 

Private Attributes

std::mutex m_Mutex
 
bool m_NewWisdomAvailable { false }
 
int m_PlanRigor { 0 }
 
bool m_ReadWisdomCache { true }
 
std::string m_WisdomCacheBase
 
WisdomFilenameGeneratorBase * m_WisdomFilenameGenerator
 
bool m_WriteWisdomCache { false }
 

Static Private Attributes

static FFTWGlobalConfigurationGlobals * m_PimplGlobals
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

using itk::FFTWGlobalConfiguration::ConstPointer = SmartPointer<const Self>

Definition at line 212 of file itkFFTWGlobalConfiguration.h.

◆ MutexType

using itk::FFTWGlobalConfiguration::MutexType = std::mutex

Definition at line 213 of file itkFFTWGlobalConfiguration.h.

◆ Pointer

using itk::FFTWGlobalConfiguration::Pointer = SmartPointer<Self>

Definition at line 211 of file itkFFTWGlobalConfiguration.h.

◆ Self

using itk::FFTWGlobalConfiguration::Self = FFTWGlobalConfiguration

Standard class type aliases.

Definition at line 209 of file itkFFTWGlobalConfiguration.h.

◆ Superclass

using itk::FFTWGlobalConfiguration::Superclass = Object

Definition at line 210 of file itkFFTWGlobalConfiguration.h.

Constructor & Destructor Documentation

◆ FFTWGlobalConfiguration()

itk::FFTWGlobalConfiguration::FFTWGlobalConfiguration ( )
private

◆ ~FFTWGlobalConfiguration()

itk::FFTWGlobalConfiguration::~FFTWGlobalConfiguration ( )
overrideprivate

Member Function Documentation

◆ ExportDefaultWisdomFile()

static bool itk::FFTWGlobalConfiguration::ExportDefaultWisdomFile ( )
static

Convenience functions to Import/Export both double and float default wisdom files

◆ ExportDefaultWisdomFileDouble()

static bool itk::FFTWGlobalConfiguration::ExportDefaultWisdomFileDouble ( )
static

Import or export some wisdom for the type double to/from the default file

◆ ExportDefaultWisdomFileFloat()

static bool itk::FFTWGlobalConfiguration::ExportDefaultWisdomFileFloat ( )
static

Import or export some wisdom for the type float to/from the default file

◆ ExportWisdomFileDouble()

static bool itk::FFTWGlobalConfiguration::ExportWisdomFileDouble ( const std::string &  fname)
static

Import or export some wisdom for the type double to/from a file

◆ ExportWisdomFileFloat()

static bool itk::FFTWGlobalConfiguration::ExportWisdomFileFloat ( const std::string &  fname)
static

Import or export some wisdom for the type float to/from a file

◆ GetInstance()

static Pointer itk::FFTWGlobalConfiguration::GetInstance ( )
staticprivate

Return the singleton instance with no reference counting.

◆ GetLockMutex()

static std::mutex & itk::FFTWGlobalConfiguration::GetLockMutex ( )
static

Get the mutex that protects calls to FFTW functions.

Referenced by itk::fftw::Proxy< float >::DestroyPlan(), itk::fftw::Proxy< double >::DestroyPlan(), itk::fftw::Proxy< float >::Plan_dft(), itk::fftw::Proxy< double >::Plan_dft(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_1d(), itk::fftw::ComplexToComplexProxy< double >::Plan_dft_1d(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_c2r(), itk::fftw::ComplexToComplexProxy< double >::Plan_dft_c2r(), itk::fftw::Proxy< float >::Plan_dft_c2r(), itk::fftw::Proxy< double >::Plan_dft_c2r(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_c2r_1d(), itk::fftw::ComplexToComplexProxy< double >::Plan_dft_c2r_1d(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_c2r_2d(), itk::fftw::ComplexToComplexProxy< double >::Plan_dft_c2r_2d(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_c2r_3d(), itk::fftw::ComplexToComplexProxy< double >::Plan_dft_c2r_3d(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_r2c(), itk::fftw::ComplexToComplexProxy< double >::Plan_dft_r2c(), itk::fftw::Proxy< float >::Plan_dft_r2c(), itk::fftw::Proxy< double >::Plan_dft_r2c(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_r2c_1d(), itk::fftw::ComplexToComplexProxy< double >::Plan_dft_r2c_1d(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_r2c_2d(), itk::fftw::ComplexToComplexProxy< double >::Plan_dft_r2c_2d(), itk::fftw::ComplexToComplexProxy< float >::Plan_dft_r2c_3d(), and itk::fftw::ComplexToComplexProxy< double >::Plan_dft_r2c_3d().

◆ GetNameOfClass()

const char * itk::FFTWGlobalConfiguration::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetNewWisdomAvailable()

static bool itk::FFTWGlobalConfiguration::GetNewWisdomAvailable ( )
static

Set/Get whether a new wisdom is available compared to the initial state. If a new wisdom is available, the wisdoms may be written to the cache file

◆ GetPlanRigor()

static int itk::FFTWGlobalConfiguration::GetPlanRigor ( )
static

◆ GetPlanRigorName()

static std::string itk::FFTWGlobalConfiguration::GetPlanRigorName ( const int  value)
static

Translate plan rigor value to name. An exception is sent if the value is not valid.

Referenced by itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWForwardFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWInverseFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), and itk::FFTWRealToHalfHermitianForwardFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor().

◆ GetPlanRigorValue()

static int itk::FFTWGlobalConfiguration::GetPlanRigorValue ( const std::string &  name)
static

Translate plan rigor name to value. An exception is sent if the name is not valid.

Referenced by itk::FFTWComplexToComplexFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), itk::FFTWHalfHermitianToRealInverseFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor(), and itk::FFTWInverseFFTImageFilter< TInputImage, TOutputImage >::SetPlanRigor().

◆ GetReadWisdomCache()

static bool itk::FFTWGlobalConfiguration::GetReadWisdomCache ( )
static

Set/Get the behavior of wisdom file caching.

If the environmental variable "ITK_FFTW_WRITE_WISDOM_CACHE", is set, then the environmental setting overrides default settings. If true, will create a wisdom file in the location

◆ GetWisdomCacheBase()

static std::string itk::FFTWGlobalConfiguration::GetWisdomCacheBase ( )
static

Define the directory where the wisdom cache will be placed. The environmental variable ITK_FFTW_WISDOM_CACHE_BASE will override the default behavior.

◆ GetWisdomFileDefaultBaseName()

static std::string itk::FFTWGlobalConfiguration::GetWisdomFileDefaultBaseName ( )
static
Returns
Returns the full path for the file to be written if WriteWisdomCache is set to true. The file name is based on the naming strategy set in SetWisdomFilenameGenerator (defaults to HardwareWisdomFilenameGenerator). The file generated by GetWisdomFileDefaultBaseName() (with an "f" suffix for single precision wisdom files). The environmental variable ITK_FFTW_WISDOM_CACHE_BASE can be used to set the base directory name to place the file name specified by the GetWisdomFileDefaultBaseName(). The default location is the users home account directory.

◆ GetWriteWisdomCache()

static bool itk::FFTWGlobalConfiguration::GetWriteWisdomCache ( )
static

Set/Get the behavior of wisdom file caching.

If the environmental variable "ITK_FFTW_WRITE_WISDOM_CACHE", is set, then the environmental setting overrides default settings. If true, will create a wisdom file in the location

◆ ImportDefaultWisdomFile()

static bool itk::FFTWGlobalConfiguration::ImportDefaultWisdomFile ( )
static

Convenience functions to Import/Export both double and float default wisdom files

◆ ImportDefaultWisdomFileDouble()

static bool itk::FFTWGlobalConfiguration::ImportDefaultWisdomFileDouble ( )
static

Import or export some wisdom for the type double to/from the default file

◆ ImportDefaultWisdomFileFloat()

static bool itk::FFTWGlobalConfiguration::ImportDefaultWisdomFileFloat ( )
static

Import or export some wisdom for the type float to/from the default file

◆ ImportWisdomFileDouble()

static bool itk::FFTWGlobalConfiguration::ImportWisdomFileDouble ( const std::string &  fname)
static

Import or export some wisdom for the type double to/from a file

◆ ImportWisdomFileFloat()

static bool itk::FFTWGlobalConfiguration::ImportWisdomFileFloat ( const std::string &  fname)
static

Import or export some wisdom for the type float to/from a file

◆ itkGetGlobalDeclarationMacro()

itk::FFTWGlobalConfiguration::itkGetGlobalDeclarationMacro ( FFTWGlobalConfigurationGlobals  ,
PimplGlobals   
)
private

◆ New()

static Pointer itk::FFTWGlobalConfiguration::New ( )
staticprivate

This is a singleton pattern New. There will only be ONE reference to a FFTWGlobalConfiguration object per process. The single instance will be unreferenced when the program exits.

◆ SetNewWisdomAvailable()

static void itk::FFTWGlobalConfiguration::SetNewWisdomAvailable ( const bool  v)
static

Set/Get whether a new wisdom is available compared to the initial state. If a new wisdom is available, the wisdoms may be written to the cache file

Referenced by itk::fftw::Proxy< float >::Plan_dft(), itk::fftw::Proxy< double >::Plan_dft(), itk::fftw::Proxy< float >::Plan_dft_c2r(), itk::fftw::Proxy< double >::Plan_dft_c2r(), itk::fftw::Proxy< float >::Plan_dft_r2c(), and itk::fftw::Proxy< double >::Plan_dft_r2c().

◆ SetPlanRigor() [1/2]

static void itk::FFTWGlobalConfiguration::SetPlanRigor ( const int  v)
static

Set the behavior of wisdom plan creation.

If the environmental variable "ITK_FFTW_PLAN_RIGOR", is set, then the environmental setting overrides default settings.

Parameters
vOne of the FFTW planner rigor flags FFTW_ESTIMATE, FFTW_MEASURE, FFTW_PATIENT, FFTW_EXHAUSTIVE

◆ SetPlanRigor() [2/2]

static void itk::FFTWGlobalConfiguration::SetPlanRigor ( const std::string &  name)
static

◆ SetReadWisdomCache()

static void itk::FFTWGlobalConfiguration::SetReadWisdomCache ( const bool  v)
static

Set/Get the behavior of wisdom file caching.

If the environmental variable "ITK_FFTW_WRITE_WISDOM_CACHE", is set, then the environmental setting overrides default settings. If true, will create a wisdom file in the location

◆ SetWisdomCacheBase()

static void itk::FFTWGlobalConfiguration::SetWisdomCacheBase ( const std::string &  v)
static

Define the directory where the wisdom cache will be placed. The environmental variable ITK_FFTW_WISDOM_CACHE_BASE will override the default behavior.

◆ SetWisdomFilenameGenerator()

static void itk::FFTWGlobalConfiguration::SetWisdomFilenameGenerator ( WisdomFilenameGeneratorBase *  wfg)
static

allows application developers to create arbitrary rules for auto-generating cache file names. A default cache strategy is set to generate separate cache files for each unique operating system and hardware permutation. Alternate representative strategies are available to meet common use cases.

See also
HardwareWisdomFilenameGenerator
SimpleWisdomFilenameGenerator
HostnameWisdomFilenameGenerator

◆ SetWriteWisdomCache()

static void itk::FFTWGlobalConfiguration::SetWriteWisdomCache ( const bool  v)
static

Set/Get the behavior of wisdom file caching.

If the environmental variable "ITK_FFTW_WRITE_WISDOM_CACHE", is set, then the environmental setting overrides default settings. If true, will create a wisdom file in the location

Member Data Documentation

◆ m_Mutex

std::mutex itk::FFTWGlobalConfiguration::m_Mutex
private

Definition at line 379 of file itkFFTWGlobalConfiguration.h.

◆ m_NewWisdomAvailable

bool itk::FFTWGlobalConfiguration::m_NewWisdomAvailable { false }
private

Definition at line 380 of file itkFFTWGlobalConfiguration.h.

◆ m_PimplGlobals

FFTWGlobalConfigurationGlobals* itk::FFTWGlobalConfiguration::m_PimplGlobals
staticprivate

Definition at line 377 of file itkFFTWGlobalConfiguration.h.

◆ m_PlanRigor

int itk::FFTWGlobalConfiguration::m_PlanRigor { 0 }
private

Definition at line 381 of file itkFFTWGlobalConfiguration.h.

◆ m_ReadWisdomCache

bool itk::FFTWGlobalConfiguration::m_ReadWisdomCache { true }
private

Definition at line 383 of file itkFFTWGlobalConfiguration.h.

◆ m_WisdomCacheBase

std::string itk::FFTWGlobalConfiguration::m_WisdomCacheBase
private

Definition at line 384 of file itkFFTWGlobalConfiguration.h.

◆ m_WisdomFilenameGenerator

WisdomFilenameGeneratorBase* itk::FFTWGlobalConfiguration::m_WisdomFilenameGenerator
private

Definition at line 387 of file itkFFTWGlobalConfiguration.h.

◆ m_WriteWisdomCache

bool itk::FFTWGlobalConfiguration::m_WriteWisdomCache { false }
private

Definition at line 382 of file itkFFTWGlobalConfiguration.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3