PeriodicBinFinderInPhi< T > Class Template Reference

#include <MagBLayer.h>

Inheritance diagram for PeriodicBinFinderInPhi< T >:

Public Member Functions
virtual int	binIndex (T phi) const
	returns an index in the valid range for the bin that contains phi More...
virtual int	binIndex (int i) const
	returns an index in the valid range, modulo Nbins More...
virtual T	binPosition (int ind) const
	the middle of the bin in radians More...
	PeriodicBinFinderInPhi ()
	PeriodicBinFinderInPhi (T firstPhi, int nbins)
Public Member Functions inherited from BaseBinFinder< T >
	BaseBinFinder ()
virtual	~BaseBinFinder ()

Static Public Member Functions
static constexpr T	pi ()
static constexpr T	twoPi ()

Private Attributes
T	theInvPhiStep =0
int	theNbins =0
T	thePhiOffset =0
T	thePhiStep =0

Static Private Attributes
static constexpr T	piC = 3.141592653589793238
static constexpr T	twoPiC = 2*piC

Detailed Description

template<class T>
class PeriodicBinFinderInPhi< T >

Periodic Bin Finder around a circle for (almost) equidistant bins. Phi is the angle on the circle in radians.

Definition at line 21 of file MagBLayer.h.

Constructor & Destructor Documentation

template<class T>

PeriodicBinFinderInPhi< T >::PeriodicBinFinderInPhi ( )

inline

Definition at line 16 of file PeriodicBinFinderInPhi.h.

{}

template<class T>

PeriodicBinFinderInPhi< T >::PeriodicBinFinderInPhi ( T  firstPhi, int  nbins  )

inline

Definition at line 18 of file PeriodicBinFinderInPhi.h.

                                                 :
    theNbins( nbins), thePhiStep( twoPiC / T(nbins)), theInvPhiStep(T(1)/thePhiStep),
    thePhiOffset( firstPhi - T(0.5)*thePhiStep) {}

Member Function Documentation

template<class T>

virtual int PeriodicBinFinderInPhi< T >::binIndex ( T  phi ) const

inlinevirtual

returns an index in the valid range for the bin that contains phi

Implements BaseBinFinder< T >.

Definition at line 23 of file PeriodicBinFinderInPhi.h.

Referenced by MuDetRing::compatibleDets(), TECLayer::computeCrossings(), MagBLayer::findVolume(), MagGeometry::findVolume(), and TECLayer::searchNeighbors().

                                     {
    T tmp = std::fmod((phi - thePhiOffset), twoPiC)*theInvPhiStep;
    if ( tmp < 0) tmp += theNbins;
    return std::min( int(tmp), theNbins-1);
  }

template<class T>

virtual int PeriodicBinFinderInPhi< T >::binIndex ( int  i ) const

inlinevirtual

returns an index in the valid range, modulo Nbins

Implements BaseBinFinder< T >.

Definition at line 30 of file PeriodicBinFinderInPhi.h.

                                     {
    int ind = i % theNbins;
    return ind < 0 ? ind+theNbins : ind;
  }

template<class T>

virtual T PeriodicBinFinderInPhi< T >::binPosition ( int  ind ) const

inlinevirtual

the middle of the bin in radians

Implements BaseBinFinder< T >.

Definition at line 36 of file PeriodicBinFinderInPhi.h.

                                        {
    return thePhiOffset + thePhiStep * ( T(ind) + T(0.5));
  }

template<class T>

static constexpr T PeriodicBinFinderInPhi< T >::pi ( )

inlinestatic

Definition at line 40 of file PeriodicBinFinderInPhi.h.

{ return piC;}

template<class T>

static constexpr T PeriodicBinFinderInPhi< T >::twoPi ( )

inlinestatic

Definition at line 41 of file PeriodicBinFinderInPhi.h.

{ return twoPiC;}

Member Data Documentation

template<class T>

constexpr T PeriodicBinFinderInPhi< T >::piC = 3.141592653589793238

staticprivate

Definition at line 45 of file PeriodicBinFinderInPhi.h.

Referenced by PeriodicBinFinderInPhi< float >::pi().

template<class T>

T PeriodicBinFinderInPhi< T >::theInvPhiStep =0

private

Definition at line 52 of file PeriodicBinFinderInPhi.h.

Referenced by PeriodicBinFinderInPhi< float >::binIndex().

template<class T>

int PeriodicBinFinderInPhi< T >::theNbins =0

private

Definition at line 50 of file PeriodicBinFinderInPhi.h.

Referenced by PeriodicBinFinderInPhi< float >::binIndex().

template<class T>

T PeriodicBinFinderInPhi< T >::thePhiOffset =0

private

Definition at line 53 of file PeriodicBinFinderInPhi.h.

Referenced by PeriodicBinFinderInPhi< float >::binIndex(), and PeriodicBinFinderInPhi< float >::binPosition().

template<class T>

T PeriodicBinFinderInPhi< T >::thePhiStep =0

private

Definition at line 51 of file PeriodicBinFinderInPhi.h.

Referenced by PeriodicBinFinderInPhi< float >::binPosition().

template<class T>

constexpr T PeriodicBinFinderInPhi< T >::twoPiC = 2*piC

staticprivate

Definition at line 46 of file PeriodicBinFinderInPhi.h.

Referenced by PeriodicBinFinderInPhi< float >::binIndex(), and PeriodicBinFinderInPhi< float >::twoPi().