RealDftData< F > Class Template Reference

#include <RealDftData.h>

Inheritance diagram for RealDftData< F >:

Public Types
using	Float = F
using	Index = unsigned int

Public Member Functions
virtual const RealDftNormalization &	normalization () const =0
virtual Index	nSample () const =0
Index	size () const
virtual Index	nCompact () const
bool	isEven () const
bool	isOdd () const
virtual bool	isValid () const
virtual void	clear ()=0
virtual void	reset (Index nsam)=0
bool	inRange (Index ifrq) const
bool	isZero (Index ifrq) const
bool	isNyquist (Index ifrq) const
bool	isNotAliased (Index ifrq) const
bool	isAliased (Index ifrq) const
virtual F	badValue () const
virtual F	amplitude (Index ifrq) const =0
virtual F	phase (Index ifrq) const =0
virtual F	real (Index ifrq) const =0
virtual F	imag (Index ifrq) const =0
F	convAmplitude (Index ifrq) const
F	compactPower (Index ifrq) const
F	power () const

Detailed Description

template<typename F>
class RealDftData< F >

Definition at line 19 of file RealDftData.h.

Member Typedef Documentation

template<typename F>

using RealDftData< F >::Float = F

Definition at line 23 of file RealDftData.h.

template<typename F>

using RealDftData< F >::Index = unsigned int

Definition at line 25 of file RealDftData.h.

Member Function Documentation

template<typename F>

virtual F RealDftData< F >::amplitude ( Index  ifrq ) const

pure virtual

Implemented in CompactRealDftData< F >.

template<typename F>

virtual F RealDftData< F >::badValue ( ) const

inlinevirtual

Definition at line 59 of file RealDftData.h.

{ return 0.0; }

template<typename F>

virtual void RealDftData< F >::clear ( )

pure virtual

Implemented in CompactRealDftData< F >.

template<typename F>

F RealDftData< F >::compactPower ( Index  ifrq ) const

inline

Definition at line 84 of file RealDftData.h.

                                   {
    if ( ifrq >= nCompact() ) return 0.0;
    F amp = amplitude(ifrq);
    F pwr = amp*amp;
    if ( normalization().isUnit() && isAliased(ifrq) ) pwr *= 2.0;
    if ( normalization().isStandard() ) pwr /= size();
    if ( normalization().isBin() ) pwr *= size();
    return pwr;
  }

template<typename F>

F RealDftData< F >::convAmplitude ( Index  ifrq ) const

inline

Definition at line 70 of file RealDftData.h.

                                    {
    if ( ifrq >= size() ) return badValue();
    if ( ! isValid() ) return badValue();
    F amp = amplitude(ifrq);
    F len = size();
    const F osq2 = 1.0/sqrt(2.0);
    if ( normalization().isConsistent() ) amp *= sqrt(len);
    if ( normalization().isBin() ) amp *= len;
    if ( normalization().isPower() && isAliased(ifrq) ) amp *= osq2;
    return amp;
  }

template<typename F>

virtual F RealDftData< F >::imag ( Index  ifrq ) const

pure virtual

Implemented in CompactRealDftData< F >.

template<typename F>

bool RealDftData< F >::inRange ( Index  ifrq ) const

inline

Definition at line 52 of file RealDftData.h.

{ return ifrq < size(); }

template<typename F>

bool RealDftData< F >::isAliased ( Index  ifrq ) const

inline

Definition at line 56 of file RealDftData.h.

{ return ifrq < size() && !isZero(ifrq) && !isNyquist(ifrq); }

template<typename F>

bool RealDftData< F >::isEven ( ) const

inline

Definition at line 37 of file RealDftData.h.

{ return (nSample() + 1) % 2; }

template<typename F>

bool RealDftData< F >::isNotAliased ( Index  ifrq ) const

inline

Definition at line 55 of file RealDftData.h.

{ return isZero(ifrq) || isNyquist(ifrq); }

template<typename F>

bool RealDftData< F >::isNyquist ( Index  ifrq ) const

inline

Definition at line 54 of file RealDftData.h.

{ return 2*ifrq == size(); }

template<typename F>

bool RealDftData< F >::isOdd ( ) const

inline

Definition at line 38 of file RealDftData.h.

{ return nSample() % 2; }

template<typename F>

virtual bool RealDftData< F >::isValid ( ) const

inlinevirtual

Definition at line 42 of file RealDftData.h.

{ return normalization().isValid() && size() > 0; }

template<typename F>

bool RealDftData< F >::isZero ( Index  ifrq ) const

inline

Definition at line 53 of file RealDftData.h.

{ return ifrq == 0; }

template<typename F>

virtual Index RealDftData< F >::nCompact ( ) const

inlinevirtual

Reimplemented in CompactRealDftData< F >.

Definition at line 36 of file RealDftData.h.

{ return nSample() ? nSample()/2 + 1 : 0; }

template<typename F>

virtual const RealDftNormalization& RealDftData< F >::normalization ( ) const

pure virtual

Implemented in CompactRealDftData< F >.

template<typename F>

virtual Index RealDftData< F >::nSample ( ) const

pure virtual

Implemented in CompactRealDftData< F >.

template<typename F>

virtual F RealDftData< F >::phase ( Index  ifrq ) const

pure virtual

Implemented in CompactRealDftData< F >.

template<typename F>

F RealDftData< F >::power ( ) const

inline

Definition at line 95 of file RealDftData.h.

                  {
    F pwr = 0.0;
    for ( Index ifrq=0; ifrq<nCompact(); ++ifrq ) {
      pwr += compactPower(ifrq);
    }
    return pwr;
  }

template<typename F>

virtual F RealDftData< F >::real ( Index  ifrq ) const

pure virtual

Implemented in CompactRealDftData< F >.

template<typename F>

virtual void RealDftData< F >::reset ( Index  nsam )

pure virtual

Implemented in CompactRealDftData< F >.

template<typename F>

Index RealDftData< F >::size ( ) const

inline

Definition at line 35 of file RealDftData.h.

{ return nSample(); }

---

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

• dunecore/dunecore/DuneCommon/Utility/RealDftData.h