RealDftNormalization Class Reference

#include <RealDftNormalization.h>

Public Types
enum	GlobalNormalization { InvalidGlobalNormalization =0, Standard =1, Consistent =2, Bin =3 }
enum	TermNormalization { InvalidTermNormalization =0, Unit =1, Power =2 }
using	Index = unsigned int

Public Member Functions
	RealDftNormalization (GlobalNormalization gnorm, TermNormalization tnorm)
	RealDftNormalization (Index ignorm, Index itnorm)
	RealDftNormalization (Index inorm)
GlobalNormalization	globalNormalization () const
bool	isStandard () const
bool	isConsistent () const
bool	isBin () const
std::string	globalName () const
TermNormalization	termNormalization () const
bool	isUnit () const
bool	isPower () const
std::string	termName () const
bool	hasValidGlobalNormalization () const
bool	hasValidTermNormalization () const
bool	isValid () const
bool	operator== (const RealDftNormalization &rhs)

Static Public Member Functions
static GlobalNormalization	getGlobalNormalization (Index iarg)
static TermNormalization	getTermNormalization (Index iarg)
static RealDftNormalization	convolutionNormalization ()

Private Attributes
GlobalNormalization	m_global = InvalidGlobalNormalization
TermNormalization	m_term = InvalidTermNormalization

Detailed Description

Definition at line 93 of file RealDftNormalization.h.

Member Typedef Documentation

using RealDftNormalization::Index = unsigned int

Definition at line 97 of file RealDftNormalization.h.

Member Enumeration Documentation

enum RealDftNormalization::GlobalNormalization

Enumerator
InvalidGlobalNormalization
Standard
Consistent
Bin

Definition at line 99 of file RealDftNormalization.h.

{ InvalidGlobalNormalization=0, Standard=1, Consistent=2, Bin=3 };

enum RealDftNormalization::TermNormalization

Enumerator
InvalidTermNormalization
Unit
Power

Definition at line 100 of file RealDftNormalization.h.

{ InvalidTermNormalization=0, Unit=1, Power=2 };

Constructor & Destructor Documentation

RealDftNormalization::RealDftNormalization ( GlobalNormalization  gnorm, TermNormalization  tnorm  )

inline

Definition at line 118 of file RealDftNormalization.h.

  : m_global(gnorm), m_term(tnorm) { }

RealDftNormalization::RealDftNormalization ( Index  ignorm, Index  itnorm  )

inline

Definition at line 120 of file RealDftNormalization.h.

  : m_global(getGlobalNormalization(ignorm)), m_term(getTermNormalization(itnorm)) { }

RealDftNormalization::RealDftNormalization ( Index  inorm )

inlineexplicit

Definition at line 123 of file RealDftNormalization.h.

: RealDftNormalization(inorm%10, inorm/10) { }

Member Function Documentation

static RealDftNormalization RealDftNormalization::convolutionNormalization ( )

inlinestatic

Definition at line 162 of file RealDftNormalization.h.

{ return RealDftNormalization(Standard, Unit); }

static GlobalNormalization RealDftNormalization::getGlobalNormalization ( Index  iarg )

inlinestatic

Definition at line 103 of file RealDftNormalization.h.

                                                                {
    if ( iarg == 1 ) return Standard;
    if ( iarg == 2 ) return Consistent;
    if ( iarg == 3 ) return Bin;
    return InvalidGlobalNormalization;
  }

static TermNormalization RealDftNormalization::getTermNormalization ( Index  iarg )

inlinestatic

Definition at line 109 of file RealDftNormalization.h.

                                                            {
    if ( iarg == 1 ) return Unit;
    if ( iarg == 2 ) return Power;
    return InvalidTermNormalization;
  }

std::string RealDftNormalization::globalName ( ) const

inline

Definition at line 130 of file RealDftNormalization.h.

                               {
    if ( isStandard() ) return "standard";
    if ( isConsistent() ) return "consistent";
    if ( isBin() ) return "bin";
    return "invalid";
  }

GlobalNormalization RealDftNormalization::globalNormalization ( ) const

inline

Definition at line 126 of file RealDftNormalization.h.

{ return m_global; }

bool RealDftNormalization::hasValidGlobalNormalization ( ) const

inline

Definition at line 148 of file RealDftNormalization.h.

{ return isStandard() || isConsistent() || isBin(); }

bool RealDftNormalization::hasValidTermNormalization ( ) const

inline

Definition at line 149 of file RealDftNormalization.h.

{ return isUnit() || isPower(); }

bool RealDftNormalization::isBin ( ) const

inline

Definition at line 129 of file RealDftNormalization.h.

{ return globalNormalization() == Bin; }

bool RealDftNormalization::isConsistent ( ) const

inline

Definition at line 128 of file RealDftNormalization.h.

{ return globalNormalization() == Consistent; }

bool RealDftNormalization::isPower ( ) const

inline

Definition at line 140 of file RealDftNormalization.h.

{ return termNormalization() == Power; }

bool RealDftNormalization::isStandard ( ) const

inline

Definition at line 127 of file RealDftNormalization.h.

{ return globalNormalization() == Standard; }

bool RealDftNormalization::isUnit ( ) const

inline

Definition at line 139 of file RealDftNormalization.h.

{ return termNormalization() == Unit; }

bool RealDftNormalization::isValid ( ) const

inline

Definition at line 150 of file RealDftNormalization.h.

{ return hasValidGlobalNormalization() && hasValidTermNormalization(); }

bool RealDftNormalization::operator== ( const RealDftNormalization &  rhs )

inline

Definition at line 153 of file RealDftNormalization.h.

                                                   {
    if ( ! isValid() ) return false;
    if ( ! rhs.isValid() ) return false;
    if ( globalNormalization() != rhs.globalNormalization() ) return false;
    if ( termNormalization() != rhs.termNormalization() ) return false;
    return true;
  }

std::string RealDftNormalization::termName ( ) const

inline

Definition at line 141 of file RealDftNormalization.h.

                             {
    if ( isUnit() ) return "unit";
    if ( isPower() ) return "power";
    return "invalid";
  }

TermNormalization RealDftNormalization::termNormalization ( ) const

inline

Definition at line 138 of file RealDftNormalization.h.

{ return m_term; }

Member Data Documentation

GlobalNormalization RealDftNormalization::m_global = InvalidGlobalNormalization

private

Definition at line 166 of file RealDftNormalization.h.

TermNormalization RealDftNormalization::m_term = InvalidTermNormalization

private

Definition at line 167 of file RealDftNormalization.h.

---

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

• dunecore/dunecore/DuneInterface/Data/RealDftNormalization.h