eflowAzimuth Class Reference

eflowAzimuth represents phi and has kinematic functions which correctly deal with phi wraparound etc. More...

#include <eflowUtil.h>

Collaboration diagram for eflowAzimuth:

Public Member Functions
	eflowAzimuth (double phi)
double	operator() () const
double	operator= (double phi)
eflowAzimuth	operator+= (double deltaPhi)
eflowAzimuth	operator-= (double deltaPhi)
double	getAbsDifference (const eflowAzimuth &other) const
double	cycle (const eflowAzimuth &other)
double	cycle (double phi)

Private Member Functions
double	adjustRange (double a)
void	adjustRange ()

Private Attributes
double	m_value {}

Detailed Description

eflowAzimuth represents phi and has kinematic functions which correctly deal with phi wraparound etc.

Definition at line 21 of file eflowUtil.h.

Constructor & Destructor Documentation

eflowAzimuth()

eflowAzimuth::eflowAzimuth ( double phi )

inline

Definition at line 23 of file eflowUtil.h.

: m_value(phi) { if (phi != -999. && !std::isnan(phi)) adjustRange(); }

Member Function Documentation

adjustRange() [1/2]

void eflowAzimuth::adjustRange ( )

inlineprivate

Definition at line 72 of file eflowUtil.h.

                            {
    if (m_value <= -M_PI) {
      m_value+=(2*M_PI*std::floor(-(m_value-M_PI)/(2*M_PI)));
    } else if (m_value > M_PI) {
      m_value-=(2*M_PI*std::floor((m_value+M_PI)/(2*M_PI)));
    }
  }

adjustRange() [2/2]

double eflowAzimuth::adjustRange ( double a )

inlineprivate

Definition at line 63 of file eflowUtil.h.

                                      {
    if (a <= -M_PI) {
      return a+(2*M_PI*std::floor(-(a-M_PI)/(2*M_PI)));
    } else if (a > M_PI) {
      return a-(2*M_PI*std::floor((a+M_PI)/(2*M_PI)));
    } else {
      return a;
    }
  }

cycle() [1/2]

double eflowAzimuth::cycle ( const eflowAzimuth & other )

inline

Definition at line 48 of file eflowUtil.h.

{ return cycle(other.m_value); }

cycle() [2/2]

double eflowAzimuth::cycle ( double phi )

inline

Definition at line 49 of file eflowUtil.h.

                                  {
    double plainDifference = phi-m_value;
    if (plainDifference > M_PI) {
      return m_value+2.0*M_PI;
    } else if (plainDifference < -M_PI) {
      return m_value-2.0*M_PI;
    } else {
      return m_value;
    }
  }

getAbsDifference()

double eflowAzimuth::getAbsDifference ( const eflowAzimuth & other ) const

inline

Definition at line 43 of file eflowUtil.h.

                                                                  {
    double plainAbsDifference = std::abs(m_value - other.m_value);
    return plainAbsDifference <= M_PI ? plainAbsDifference : 2*M_PI - plainAbsDifference;
  }

operator()()

double eflowAzimuth::operator() ( ) const

inline

Definition at line 25 of file eflowUtil.h.

{ return m_value; }

operator+=()

eflowAzimuth eflowAzimuth::operator+= ( double deltaPhi )

inline

Definition at line 32 of file eflowUtil.h.

                                                 {
    m_value += deltaPhi;
    adjustRange();
    return *this;
  }

operator-=()

eflowAzimuth eflowAzimuth::operator-= ( double deltaPhi )

inline

Definition at line 37 of file eflowUtil.h.

                                                 {
    m_value -= deltaPhi;
    adjustRange();
    return *this;
  }

operator=()

double eflowAzimuth::operator= ( double phi )

inline

Definition at line 26 of file eflowUtil.h.

                                     {
    m_value = phi;
    adjustRange();
    return m_value;
  }

Member Data Documentation

m_value

double eflowAzimuth::m_value {}

private

Definition at line 61 of file eflowUtil.h.

{};

---

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

• eflowUtil.h