CompactRealDftData< F > Class Template Reference

#include <CompactRealDftData.h>

Inheritance diagram for CompactRealDftData< F >:

Public Types
using	FloatVector = std::vector< F >
using	Norm = RealDftNormalization
Public Types inherited from RealDftData< F >
using	Float = F
using	Index = unsigned int

Public Member Functions
	CompactRealDftData ()=default
	CompactRealDftData (Norm norm)
	CompactRealDftData (Norm norm, Index nsam)
	CompactRealDftData (Norm norm, const FloatVector &amps, const FloatVector &phas)
	CompactRealDftData (const FloatVector &amps, const FloatVector &phas)
	CompactRealDftData (const RealDftData< F > &rhs)
const Norm &	normalization () const override
void	clear () override
void	reset (Index nsam) override
int	moveIn (FloatVector &amps, FloatVector &phas)
int	copyIn (const FloatVector &amps, const FloatVector &phas)
int	setAmplitude (Index ifrq, F val)
int	setPhase (Index ifrq, F val)
int	moveOut (FloatVector &amps, FloatVector &phas)
int	copyOut (FloatVector &amps, FloatVector &phas) const
Index	nSample () const override
Index	nCompact () const override
F	amplitude (Index ifrq) const override
F	phase (Index ifrq) const override
F	real (Index ifrq) const override
F	imag (Index ifrq) const override
Index	nAmplitude () const
Index	nPhase () const
F	compactAmplitude (Index ifrq) const
F	compactPhase (Index ifrq) const
Public Member Functions inherited from RealDftData< F >
Index	size () const
bool	isEven () const
bool	isOdd () const
virtual bool	isValid () const
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
F	convAmplitude (Index ifrq) const
F	compactPower (Index ifrq) const
F	power () const

Private Attributes
Norm	m_norm
FloatVector	m_amps
FloatVector	m_phas

Detailed Description

template<typename F>
class CompactRealDftData< F >

Definition at line 16 of file CompactRealDftData.h.

Member Typedef Documentation

template<typename F >

using CompactRealDftData< F >::FloatVector = std::vector<F>

Definition at line 21 of file CompactRealDftData.h.

template<typename F >

using CompactRealDftData< F >::Norm = RealDftNormalization

Definition at line 22 of file CompactRealDftData.h.

Constructor & Destructor Documentation

template<typename F >

CompactRealDftData< F >::CompactRealDftData ( )

default

template<typename F >

CompactRealDftData< F >::CompactRealDftData ( Norm  norm )

inlineexplicit

Definition at line 28 of file CompactRealDftData.h.

  : m_norm(norm) { }

template<typename F >

CompactRealDftData< F >::CompactRealDftData ( Norm  norm, Index  nsam  )

inline

Definition at line 32 of file CompactRealDftData.h.

  : m_norm(norm) {
    reset(nsam);
  }

template<typename F >

CompactRealDftData< F >::CompactRealDftData ( Norm  norm, const FloatVector &  amps, const FloatVector &  phas  )

inline

Definition at line 40 of file CompactRealDftData.h.

  : m_norm(norm), m_amps(amps), m_phas(phas) {
    Index namp = amps.size();
    Index npha = phas.size();
    if ( namp < npha || namp > npha + 1 ) clear();
  }

template<typename F >

CompactRealDftData< F >::CompactRealDftData ( const FloatVector &  amps, const FloatVector &  phas  )

inline

Definition at line 50 of file CompactRealDftData.h.

  : m_amps(amps), m_phas(phas) {
    Index namp = amps.size();
    Index npha = phas.size();
    if ( namp < npha || namp > npha + 1 ) clear();
  }

template<typename F >

CompactRealDftData< F >::CompactRealDftData ( const RealDftData< F > &  rhs )

inline

Definition at line 58 of file CompactRealDftData.h.

                                                {
    if ( &rhs == this ) return;
    if ( ! rhs.isValid() ) return;
    Index nsam = rhs.nSample();
    if ( nsam == 0 ) return;
    Index namp = rhs.nCompact();
    Index npha = nsam - namp + 1;
    if ( namp < npha || namp > npha + 1 ) { clear(); return; }
    m_amps.resize(namp);
    m_phas.resize(npha);
    if ( nsam == 0 ) return;
    F gfac = 1.0;
    if ( rhs.isPower() ) gfac *= sqrt(nsam);
    if ( rhs.isBin() ) gfac *= nsam;
    if ( this->isPower() ) gfac /= sqrt(nsam);
    if ( this->isBin() ) gfac /= nsam;
    F tfac = 1.0;
    if ( rhs.isUnit() && ! this->isUnit() ) tfac = 1/sqrt(2.0);
    if ( ! rhs.isUnit() && this->isUnit() ) tfac = sqrt(2.0);
    for ( Index ifrq=0; ifrq<namp; ++ifrq ) {
      F amp = gfac*rhs.amplitude(ifrq);
      if ( this->isAliased(ifrq) ) amp *= tfac;
      m_amps[ifrq] = amp;
      if ( ifrq < npha ) m_phas[ifrq] = rhs.phase(ifrq);
    }
  }

Member Function Documentation

template<typename F >

F CompactRealDftData< F >::amplitude ( Index  ifrq ) const

inlineoverridevirtual

Implements RealDftData< F >.

Definition at line 161 of file CompactRealDftData.h.

                                         {
    return ifrq < this->nAmplitude() ? this->compactAmplitude(ifrq) :
           ifrq < this->size() ? this->compactAmplitude(this->size()-ifrq) :
           this->badValue();
  }

template<typename F >

void CompactRealDftData< F >::clear ( )

inlineoverridevirtual

Implements RealDftData< F >.

Definition at line 89 of file CompactRealDftData.h.

                        {
    m_amps.clear();
    m_phas.clear();
  }

template<typename F >

F CompactRealDftData< F >::compactAmplitude ( Index  ifrq ) const

inline

Definition at line 186 of file CompactRealDftData.h.

                                       {
    return this->inRange(ifrq) ? m_amps[ifrq] : this->badValue();
  }

template<typename F >

F CompactRealDftData< F >::compactPhase ( Index  ifrq ) const

inline

Definition at line 189 of file CompactRealDftData.h.

                                   {
    return this->inRange(ifrq) ? m_phas[ifrq] : this->badValue();
  }

template<typename F >

int CompactRealDftData< F >::copyIn ( const FloatVector &  amps, const FloatVector &  phas  )

inline

Definition at line 118 of file CompactRealDftData.h.

                                                               {
    Index namp = amps.size();
    Index npha = phas.size();
    if ( namp < npha || namp > npha + 1 ) {
      clear();
      return 1;
    }
    m_amps = amps;
    m_phas = phas;
    return 0;
  }

template<typename F >

int CompactRealDftData< F >::copyOut ( FloatVector &  amps, FloatVector &  phas  ) const

inline

Definition at line 150 of file CompactRealDftData.h.

                                                          {
    amps = m_amps;
    phas = m_phas;
    return 0;
  }

template<typename F >

F CompactRealDftData< F >::imag ( Index  ifrq ) const

inlineoverridevirtual

Implements RealDftData< F >.

Definition at line 176 of file CompactRealDftData.h.

                                    {
    return ifrq < this->nPhase() ? amplitude(ifrq)*sin(phase(ifrq)) :
           2*ifrq == this->size() ? 0.0 :
           ifrq < this->size() ? -amplitude(ifrq)*sin(phase(ifrq)) :
           this->badValue();
  }

template<typename F >

int CompactRealDftData< F >::moveIn ( FloatVector &  amps, FloatVector &  phas  )

inline

Definition at line 105 of file CompactRealDftData.h.

                                                   {
    Index namp = amps.size();
    Index npha = phas.size();
    if ( namp < npha || namp > npha + 1 ) {
      clear();
      return 1;
    }
    m_amps = std::move(amps);
    m_phas = std::move(phas);
    return 0;
  }

template<typename F >

int CompactRealDftData< F >::moveOut ( FloatVector &  amps, FloatVector &  phas  )

inline

Definition at line 143 of file CompactRealDftData.h.

                                                    {
    amps = std::move(m_amps);
    phas = std::move(m_phas);
    return 0;
  }

template<typename F >

Index CompactRealDftData< F >::nAmplitude ( ) const

inline

Definition at line 184 of file CompactRealDftData.h.

{ return m_amps.size(); }

template<typename F >

Index CompactRealDftData< F >::nCompact ( ) const

inlineoverridevirtual

Reimplemented from RealDftData< F >.

Definition at line 158 of file CompactRealDftData.h.

{ return nAmplitude(); }

template<typename F >

const Norm& CompactRealDftData< F >::normalization ( ) const

inlineoverridevirtual

Implements RealDftData< F >.

Definition at line 86 of file CompactRealDftData.h.

{ return m_norm; }

template<typename F >

Index CompactRealDftData< F >::nPhase ( ) const

inline

Definition at line 185 of file CompactRealDftData.h.

{ return m_phas.size(); }

template<typename F >

Index CompactRealDftData< F >::nSample ( ) const

inlineoverridevirtual

Implements RealDftData< F >.

Definition at line 157 of file CompactRealDftData.h.

{ return nCompact() ? nCompact() + nPhase() - 1 : 0; }

template<typename F >

F CompactRealDftData< F >::phase ( Index  ifrq ) const

inlineoverridevirtual

Implements RealDftData< F >.

Definition at line 166 of file CompactRealDftData.h.

                                     {
    return ifrq < this->nPhase() ? this->compactPhase(ifrq) :
           2*ifrq == this->size() ? 0.0 :
           ifrq < this->size() ? -this->compactPhase(this->size()-ifrq) :
           this->badValue();
  }

template<typename F >

F CompactRealDftData< F >::real ( Index  ifrq ) const

inlineoverridevirtual

Implements RealDftData< F >.

Definition at line 172 of file CompactRealDftData.h.

                                    {
    return ifrq < this->size() ? amplitude(ifrq)*cos(phase(ifrq)) :
    this->badValue();
  }

template<typename F >

void CompactRealDftData< F >::reset ( Index  nsam )

inlineoverridevirtual

Implements RealDftData< F >.

Definition at line 95 of file CompactRealDftData.h.

                                  {
    Index namp = nsam > 0 ? nsam/2 + 1 : 0;
    Index npha = (nsam + 1)/2;
    m_amps.resize(namp);
    m_phas.resize(npha);
    for ( F& amp : m_amps ) amp = 0.0;
    for ( F& pha : m_phas ) pha = 0.0;
  }

template<typename F >

int CompactRealDftData< F >::setAmplitude ( Index  ifrq, F  val  )

inline

Definition at line 131 of file CompactRealDftData.h.

                                      {
    if ( ifrq >= nAmplitude() ) return 1;
    m_amps[ifrq] = val;
    return 0;
  }

template<typename F >

int CompactRealDftData< F >::setPhase ( Index  ifrq, F  val  )

inline

Definition at line 136 of file CompactRealDftData.h.

                                  {
    if ( ifrq >= nPhase() ) return 1;
    m_phas[ifrq] = val;
    return 0;
  }

Member Data Documentation

template<typename F >

FloatVector CompactRealDftData< F >::m_amps

private

Definition at line 197 of file CompactRealDftData.h.

template<typename F >

Norm CompactRealDftData< F >::m_norm

private

Definition at line 196 of file CompactRealDftData.h.

template<typename F >

FloatVector CompactRealDftData< F >::m_phas

private

Definition at line 198 of file CompactRealDftData.h.

---

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

• dunecore/dunecore/DuneCommon/Utility/CompactRealDftData.h