FFTSettings< T > Class Template Reference

#include <fft_settings.h>

Public Member Functions
	FFTSettings (size_t x, size_t y=1, size_t z=1, size_t n=1, size_t batch=1, bool isInPlace=false, bool isForward=true)
	FFTSettings (const Dimensions &spatial, size_t batch=1, bool isInPlace=false, bool isForward=true)
constexpr Dimensions	sDim () const
constexpr Dimensions	fDim () const
constexpr size_t	batch () const
constexpr size_t	fBytesSingle () const
constexpr size_t	fBytes () const
constexpr size_t	fBytesBatch () const
constexpr size_t	fElemsBatch () const
constexpr size_t	sBytesSingle () const
constexpr size_t	sBytes () const
constexpr size_t	sBytesBatch () const
constexpr size_t	sElemsBatch () const
constexpr bool	isForward () const
constexpr bool	isInPlace () const
constexpr size_t	maxBytesBatch () const
FFTSettings< T >	createInverse () const
FFTSettings< T >	createSingle () const
FFTSettings< T >	createBatch () const
FFTSettings< T >	createSubset (size_t n) const
FFTSettings< T >	copyForBatch (size_t b) const

Friends
std::ostream &	operator (std::ostream &os, const FFTSettings< T > &s)

Detailed Description

template<typename T>
class FFTSettings< T >

Definition at line 38 of file fft_settings.h.

Constructor & Destructor Documentation

FFTSettings() [1/2]

template<typename T>

FFTSettings< T >::FFTSettings ( size_t  x, size_t  y = 1, size_t  z = 1, size_t  n = 1, size_t  batch = 1, bool  isInPlace = false, bool  isForward = true  )

inlineexplicit

Definition at line 44 of file fft_settings.h.

                                   :
            m_spatial(x, y, z, n),
            m_freq(x / 2 + 1, y, z, n),
            m_batch(batch),
            m_isInPlace(isInPlace),
            m_isForward(isForward) {
        if (isInPlace) {
            size_t padding = (m_freq.x() * 2) - x;
            m_spatial = Dimensions(x, y, z, n, padding);
        }
        assert(batch <= n);
        assert(batch > 0);
    };

FFTSettings() [2/2]

template<typename T>

FFTSettings< T >::FFTSettings ( const Dimensions &  spatial, size_t  batch = 1, bool  isInPlace = false, bool  isForward = true  )

inlineexplicit

Definition at line 61 of file fft_settings.h.

                                   :
            m_spatial(spatial),
            m_freq(spatial.x() / 2 + 1, spatial.y(), spatial.z(), spatial.n()),
            m_batch(batch),
            m_isInPlace(isInPlace),
            m_isForward(isForward) {
        if (isInPlace) {
            size_t padding = (m_freq.x() * 2) - spatial.x();
            m_spatial = Dimensions(spatial.x(), spatial.y(), spatial.z(), spatial.n(), padding);
        }
        assert(batch <= spatial.n());
        assert(batch > 0);
    };

Member Function Documentation

batch()

template<typename T>

constexpr size_t FFTSettings< T >::batch ( ) const

inline

Definition at line 86 of file fft_settings.h.

                                   {
        return m_batch;
    }

copyForBatch()

template<typename T>

FFTSettings<T> FFTSettings< T >::copyForBatch ( size_t  b ) const

inline

Definition at line 159 of file fft_settings.h.

                                                       {
        assert(b <= m_spatial.n());
        auto copy = FFTSettings<T>(m_spatial.x(), m_spatial.y(), m_spatial.z(), m_spatial.n(), b,
                this->isInPlace(), this->isForward());
        return copy;
    }

createBatch()

template<typename T>

FFTSettings<T> FFTSettings< T >::createBatch ( ) const

inline

Definition at line 146 of file fft_settings.h.

                                              {
        auto copy = FFTSettings<T>(m_spatial.x(), m_spatial.y(), m_spatial.z(), m_batch, m_batch,
                this->isInPlace(), this->isForward());
        return copy;
    }

createInverse()

template<typename T>

FFTSettings<T> FFTSettings< T >::createInverse ( ) const

inline

Definition at line 134 of file fft_settings.h.

                                                {
        auto copy = FFTSettings<T>(*this);
        copy.m_isForward = ! this->m_isForward;
        return copy;
    }

createSingle()

template<typename T>

FFTSettings<T> FFTSettings< T >::createSingle ( ) const

inline

Definition at line 140 of file fft_settings.h.

                                               {
        auto copy = FFTSettings<T>(m_spatial.x(), m_spatial.y(), m_spatial.z(), 1, 1,
                this->isInPlace(), this->isForward());
        return copy;
    }

createSubset()

template<typename T>

FFTSettings<T> FFTSettings< T >::createSubset ( size_t  n ) const

inline

Definition at line 152 of file fft_settings.h.

                                                       {
        assert(n <= m_spatial.n());
        auto copy = FFTSettings<T>(m_spatial.x(), m_spatial.y(), m_spatial.z(), n, n,
                this->isInPlace(), this->isForward());
        return copy;
    }

fBytes()

template<typename T>

constexpr size_t FFTSettings< T >::fBytes ( ) const

inline

Definition at line 94 of file fft_settings.h.

                                    {
        return m_freq.sizePadded() * sizeof(std::complex<T>);
    }

fBytesBatch()

template<typename T>

constexpr size_t FFTSettings< T >::fBytesBatch ( ) const

inline

Definition at line 98 of file fft_settings.h.

                                         {
        return m_freq.xyzPadded() * m_batch * sizeof(std::complex<T>);
    }

fBytesSingle()

template<typename T>

constexpr size_t FFTSettings< T >::fBytesSingle ( ) const

inline

Definition at line 90 of file fft_settings.h.

                                          {
        return m_freq.xyzPadded() * sizeof(std::complex<T>);
    }

fDim()

template<typename T>

constexpr Dimensions FFTSettings< T >::fDim ( ) const

inline

Definition at line 82 of file fft_settings.h.

                                      {
        return m_freq;
    }

fElemsBatch()

template<typename T>

constexpr size_t FFTSettings< T >::fElemsBatch ( ) const

inline

Definition at line 102 of file fft_settings.h.

                                         {
        return m_freq.xyzPadded() * m_batch;
    }

isForward()

template<typename T>

constexpr bool FFTSettings< T >::isForward ( ) const

inline

Definition at line 122 of file fft_settings.h.

                                     {
        return m_isForward;
    }

isInPlace()

template<typename T>

constexpr bool FFTSettings< T >::isInPlace ( ) const

inline

Definition at line 126 of file fft_settings.h.

                                     {
        return m_isInPlace;
    }

maxBytesBatch()

template<typename T>

constexpr size_t FFTSettings< T >::maxBytesBatch ( ) const

inline

Definition at line 130 of file fft_settings.h.

                                           {
        return sBytesBatch() + (m_isInPlace ? 0 :fBytesBatch());
    }

sBytes()

template<typename T>

constexpr size_t FFTSettings< T >::sBytes ( ) const

inline

Definition at line 110 of file fft_settings.h.

                                    {
        return m_spatial.sizePadded() * sizeof(T);
    }

sBytesBatch()

template<typename T>

constexpr size_t FFTSettings< T >::sBytesBatch ( ) const

inline

Definition at line 114 of file fft_settings.h.

                                         {
        return m_spatial.xyzPadded() * m_batch * sizeof(T);
    }

sBytesSingle()

template<typename T>

constexpr size_t FFTSettings< T >::sBytesSingle ( ) const

inline

Definition at line 106 of file fft_settings.h.

                                          {
        return m_spatial.xyzPadded() * sizeof(T);
    }

sDim()

template<typename T>

constexpr Dimensions FFTSettings< T >::sDim ( ) const

inline

Definition at line 78 of file fft_settings.h.

                                      {
        return m_spatial;
    }

sElemsBatch()

template<typename T>

constexpr size_t FFTSettings< T >::sElemsBatch ( ) const

inline

Definition at line 118 of file fft_settings.h.

                                         {
        return m_spatial.xyzPadded() * m_batch;
    }

Friends And Related Function Documentation

operator

template<typename T>

std::ostream& operator ( std::ostream &  os, const FFTSettings< T > &  s  )

friend

---

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

• xmipp/libraries/data/fft_settings.h