Geom::Phi< T1, Range > Class Template Reference

#include <Phi.h>

Public Member Functions
T1	degrees () const
bool	nearEqual (const Phi< T1, Range > &angle, float tolerance=0.001) const
bool	nearZero (float tolerance=1.0_deg) const
template<typename T2 , typename Range1 >
	operator Phi< T2, Range1 > ()
	Template argument conversion. More...
	operator T1 () const
	conversion operator makes transparent use possible. More...
Phi &	operator*= (const T1 &a)
Phi &	operator+= (const T1 &a)
	Standard arithmetics. More...
Phi &	operator+= (const Phi &a)
Phi &	operator-= (const T1 &a)
Phi &	operator-= (const Phi &a)
Phi &	operator/= (const T1 &a)
	Phi ()
	Default constructor does not initialise - just as double. More...
	Phi (const T1 &val)
T1	phi () const
T1	value () const
	Explicit access to value in case implicit conversion not OK. More...

Private Member Functions
void	normalize (T1 &value)

Private Attributes
T1	theValue

Detailed Description

template<typename T1, typename Range = MinusPiToPi>
class Geom::Phi< T1, Range >

A class for azimuthal angle represantation and algebra. The use of Phi<T> is tranparant due to the implicit conversion to T Constructs like cos(phi) work as with float or double. The difference with respect to built-in types is that Phi is kept in the range (-pi, pi] by default, and this is consistently implemented in aritmetic operations. In other words, Phi implements "modulo(2 pi)" arithmetics. Phi can be instantiated to implement the range 0 to 2pi.

Definition at line 52 of file Phi.h.

Constructor & Destructor Documentation

Phi() [1/2]

template<typename T1, typename Range = MinusPiToPi>

Geom::Phi< T1, Range >::Phi ( )

inline

Default constructor does not initialise - just as double.

Definition at line 55 of file Phi.h.

{}

Phi() [2/2]

template<typename T1, typename Range = MinusPiToPi>

Geom::Phi< T1, Range >::Phi ( const T1 &  val )

inline

Definition at line 63 of file Phi.h.

: theValue(val) { normalize(theValue); }

Member Function Documentation

degrees()

template<typename T1, typename Range = MinusPiToPi>

T1 Geom::Phi< T1, Range >::degrees ( ) const

inline

Definition at line 107 of file Phi.h.

Referenced by CSCRecHit2DValidation::analyze(), TrackerHitAnalyzer::analyze(), Geant4ePropagator::debugReportPlaneSetup(), and Geant4ePropagator::debugReportTrackState().

{ return convertRadToDeg(theValue); }

nearEqual()

template<typename T1, typename Range = MinusPiToPi>

bool Geom::Phi< T1, Range >::nearEqual ( const Phi< T1, Range > &  angle, float  tolerance = 0.001  ) const

inline

Definition at line 115 of file Phi.h.

                                                                                      {
      return (std::abs(theValue - angle) - tolerance <= 0.0);
    }

nearZero()

template<typename T1, typename Range = MinusPiToPi>

bool Geom::Phi< T1, Range >::nearZero ( float  tolerance = 1.0_deg ) const

inline

Definition at line 111 of file Phi.h.

{ return (std::abs(theValue) - tolerance <= 0.0); }

normalize()

template<typename T1, typename Range = MinusPiToPi>

void Geom::Phi< T1, Range >::normalize ( T1 &  value )

inlineprivate

Definition at line 122 of file Phi.h.

Referenced by Geom::Phi< float >::operator*=(), Geom::Phi< float >::operator+=(), Geom::Phi< float >::operator-=(), Geom::Phi< float >::operator/=(), and Geom::Phi< float >::Phi().

{ NormalizeWrapper<T1, Range>::normalize(value); }

operator Phi< T2, Range1 >()

template<typename T1, typename Range = MinusPiToPi>

template<typename T2 , typename Range1 >

Geom::Phi< T1, Range >::operator Phi< T2, Range1 > ( )

inline

Template argument conversion.

Definition at line 70 of file Phi.h.

                               {
      return Phi<T2, Range1>(theValue);
    }

operator T1()

template<typename T1, typename Range = MinusPiToPi>

Geom::Phi< T1, Range >::operator T1 ( ) const

inline

conversion operator makes transparent use possible.

Definition at line 66 of file Phi.h.

References Geom::Phi< T1, Range >::theValue.

{ return theValue; }

operator*=()

template<typename T1, typename Range = MinusPiToPi>

Phi& Geom::Phi< T1, Range >::operator*= ( const T1 &  a )

inline

Definition at line 95 of file Phi.h.

                                 {
      theValue *= a;
      normalize(theValue);
      return *this;
    }

operator+=() [1/2]

template<typename T1, typename Range = MinusPiToPi>

Phi& Geom::Phi< T1, Range >::operator+= ( const T1 &  a )

inline

Standard arithmetics.

Definition at line 81 of file Phi.h.

                                 {
      theValue += a;
      normalize(theValue);
      return *this;
    }

operator+=() [2/2]

template<typename T1, typename Range = MinusPiToPi>

Phi& Geom::Phi< T1, Range >::operator+= ( const Phi< T1, Range > &  a )

inline

Definition at line 86 of file Phi.h.

Referenced by Geom::Phi< float >::operator+=().

{ return operator+=(a.value()); }

operator-=() [1/2]

template<typename T1, typename Range = MinusPiToPi>

Phi& Geom::Phi< T1, Range >::operator-= ( const T1 &  a )

inline

Definition at line 88 of file Phi.h.

                                 {
      theValue -= a;
      normalize(theValue);
      return *this;
    }

operator-=() [2/2]

template<typename T1, typename Range = MinusPiToPi>

Phi& Geom::Phi< T1, Range >::operator-= ( const Phi< T1, Range > &  a )

inline

Definition at line 93 of file Phi.h.

Referenced by Geom::Phi< float >::operator-=().

{ return operator-=(a.value()); }

operator/=()

template<typename T1, typename Range = MinusPiToPi>

Phi& Geom::Phi< T1, Range >::operator/= ( const T1 &  a )

inline

Definition at line 101 of file Phi.h.

                                 {
      theValue /= a;
      normalize(theValue);
      return *this;
    }

phi()

template<typename T1, typename Range = MinusPiToPi>

T1 Geom::Phi< T1, Range >::phi ( ) const

inline

Definition at line 78 of file Phi.h.

Referenced by Particle.Particle::__str__(), L2MuonSeedGenerator::associateOfflineSeedToL1(), L2MuonSeedGeneratorFromL1T::associateOfflineSeedToL1(), L2MuonSeedGeneratorFromL1TkMu::associateOfflineSeedToL1(), MuonTrackResidualAnalyzer::computeResolution(), CSCSegAlgoSK::dumpHits(), CSCSegAlgoTC::dumpHits(), CaloGeometryHelper::getClosestCell(), L2MuonSeedGeneratorFromL1T::isAssociateOfflineSeedToL1(), ntupleDataFormat.Track::phiPull(), and lowptgsfeleid::trackClusterMatching().

{ return theValue; }

value()

template<typename T1, typename Range = MinusPiToPi>

T1 Geom::Phi< T1, Range >::value ( ) const

inline

Explicit access to value in case implicit conversion not OK.

Definition at line 75 of file Phi.h.

Referenced by Types.int32::__nonzero__(), Types.uint32::__nonzero__(), Types.int64::__nonzero__(), Types.uint64::__nonzero__(), Types.double::__nonzero__(), Types.bool::__nonzero__(), Types.string::__nonzero__(), reco::WMuNuCandidate::acop(), EwkMuDQM::analyze(), HGCalHitValidation::analyze(), average.Average::average(), Types.string::configValue(), Types.FileInPath::configValue(), Mixins.UsingBlock::dumpPython(), L1TMuon::GeometryTranslator::getCSCSpecificPoint(), OmtfAngleConverter::getGlobalEta(), AngleConverter::getGlobalEta(), Mixins.UsingBlock::insertInto(), Types.int32::insertInto(), Types.uint32::insertInto(), Types.int64::insertInto(), Types.uint64::insertInto(), Types.double::insertInto(), Types.bool::insertInto(), Types.string::insertInto(), Types.FileInPath::insertInto(), Types.vint32::insertInto(), Types.vuint32::insertInto(), Types.vint64::insertInto(), Types.vuint64::insertInto(), Types.vdouble::insertInto(), Types.vbool::insertInto(), Types.vstring::insertInto(), PhiBorderFinder::PhiBorderFinder(), RecHitProcessor::process(), and RecHitProcessor::processLook().

{ return theValue; }

Member Data Documentation

theValue

template<typename T1, typename Range = MinusPiToPi>

T1 Geom::Phi< T1, Range >::theValue

private

Definition at line 120 of file Phi.h.

Referenced by Geom::Phi< float >::degrees(), Geom::Phi< float >::nearEqual(), Geom::Phi< float >::nearZero(), Geom::Phi< float >::operator Phi< T2, Range1 >(), Geom::Phi< T1, Range >::operator T1(), Geom::Phi< float >::operator*=(), Geom::Phi< float >::operator+=(), Geom::Phi< float >::operator-=(), Geom::Phi< float >::operator/=(), Geom::Phi< float >::Phi(), Geom::Phi< float >::phi(), and Geom::Phi< float >::value().