MagBinFinders::GeneralBinFinderInZ< T > Class Template Reference

#include <MagBinFinders.h>

Inheritance diagram for MagBinFinders::GeneralBinFinderInZ< T >:

Public Member Functions
int	binIndex (T z) const override
	returns an index in the valid range for the bin closest to Z More...
int	binIndex (int i) const override
	returns an index in the valid range More...
T	binPosition (int ind) const override
	the middle of the bin. More...
	GeneralBinFinderInZ ()
	GeneralBinFinderInZ (std::vector< T > &borders)
Public Member Functions inherited from BaseBinFinder< T >
	BaseBinFinder ()
virtual	~BaseBinFinder ()

Static Public Member Functions
static double	pi ()
static double	twoPi ()

Private Attributes
std::vector< T >	theBins
std::vector< T >	theBorders
int	theNbins
T	theZOffset
T	theZStep

Detailed Description

template<class T>
class MagBinFinders::GeneralBinFinderInZ< T >

A Z bin finder for a non-periodic group of detectors. Search is done starting from an initial equal-size-bin guess. Therefore it becomes less efficient for binnings with very different bin size. It is not particularily suited for very few bins...

Definition at line 10 of file MagBinFinders.h.

Constructor & Destructor Documentation

template<class T>

MagBinFinders::GeneralBinFinderInZ< T >::GeneralBinFinderInZ ( )

inline

Definition at line 103 of file MagBinFinders.h.

: theNbins(0), theZStep(0), theZOffset(0) {}

template<class T>

MagBinFinders::GeneralBinFinderInZ< T >::GeneralBinFinderInZ ( std::vector< T > &  borders )

inline

Definition at line 105 of file MagBinFinders.h.

      : theNbins(borders.size()), theBorders(++(borders.begin()), borders.end()) {  // Skip border of 1. bin
    // FIXME:  crashes for borders.size()==1 (trivial case)
    // FIXME set theBins!!!
    theZOffset = theBorders.front();
    if (theNbins > 2) {
      theZStep = (theBorders.back() - theBorders.front()) / (theNbins - 2);
    } else {
      theZStep = 1.;  // Not relevant in this case...
    }

    //     cout << "GeneralBinFinderInZ " << theBorders.size()
    //   << " " << theZStep << endl;
  }

Member Function Documentation

template<class T>

int MagBinFinders::GeneralBinFinderInZ< T >::binIndex ( T  z ) const

inlineoverridevirtual

returns an index in the valid range for the bin closest to Z

Implements BaseBinFinder< T >.

Definition at line 139 of file MagBinFinders.h.

Referenced by MagBinFinders::GeneralBinFinderInZ< double >::binIndex(), MagBinFinders::GeneralBinFinderInZ< double >::binPosition(), and MagBRod::findVolume().

                                   {
    int bin = binIndex(int((z - theZOffset) / theZStep) + 1);

    // check left border
    if (bin > 0) {
      if (z < theBorders[bin - 1]) {
        // z is to the left of the left border, the correct bin is left
        for (int i = bin - 1;; --i) {
          if (i <= 0)
            return 0;
          if (z > theBorders[i - 1])
            return i;
        }
      }
    } else
      return 0;

    // check right border
    if (bin < theNbins - 1) {
      if (z > theBorders[bin]) {
        // z is to the right of the right border, the correct bin is right
        for (int i = bin + 1;; ++i) {
          if (i >= theNbins - 1)
            return theNbins - 1;
          if (z < theBorders[i])
            return i;
        }
      }
    } else
      return theNbins - 1;

    // if we arrive here it means that the bin is ok
    return bin;
  }

template<class T>

int MagBinFinders::GeneralBinFinderInZ< T >::binIndex ( int  i ) const

inlineoverridevirtual

returns an index in the valid range

Implements BaseBinFinder< T >.

Definition at line 175 of file MagBinFinders.h.

{ return std::min(std::max(i, 0), theNbins - 1); }

template<class T>

T MagBinFinders::GeneralBinFinderInZ< T >::binPosition ( int  ind ) const

inlineoverridevirtual

the middle of the bin.

Implements BaseBinFinder< T >.

Definition at line 178 of file MagBinFinders.h.

{ return theBins[binIndex(ind)]; }

template<class T>

static double MagBinFinders::GeneralBinFinderInZ< T >::pi ( )

inlinestatic

Definition at line 180 of file MagBinFinders.h.

Referenced by MagBinFinders::GeneralBinFinderInZ< double >::twoPi().

{ return 3.141592653589793238; }

template<class T>

static double MagBinFinders::GeneralBinFinderInZ< T >::twoPi ( )

inlinestatic

Definition at line 181 of file MagBinFinders.h.

{ return 2. * pi(); }

Member Data Documentation

template<class T>

std::vector<T> MagBinFinders::GeneralBinFinderInZ< T >::theBins

private

Definition at line 188 of file MagBinFinders.h.

Referenced by MagBinFinders::GeneralBinFinderInZ< double >::binPosition().

template<class T>

std::vector<T> MagBinFinders::GeneralBinFinderInZ< T >::theBorders

private

Definition at line 187 of file MagBinFinders.h.

Referenced by MagBinFinders::GeneralBinFinderInZ< double >::binIndex(), and MagBinFinders::GeneralBinFinderInZ< double >::GeneralBinFinderInZ().

template<class T>

int MagBinFinders::GeneralBinFinderInZ< T >::theNbins

private

Definition at line 184 of file MagBinFinders.h.

Referenced by MagBinFinders::GeneralBinFinderInZ< double >::binIndex(), and MagBinFinders::GeneralBinFinderInZ< double >::GeneralBinFinderInZ().

template<class T>

T MagBinFinders::GeneralBinFinderInZ< T >::theZOffset

private

Definition at line 186 of file MagBinFinders.h.

Referenced by MagBinFinders::GeneralBinFinderInZ< double >::binIndex(), and MagBinFinders::GeneralBinFinderInZ< double >::GeneralBinFinderInZ().

template<class T>

T MagBinFinders::GeneralBinFinderInZ< T >::theZStep

private

Definition at line 185 of file MagBinFinders.h.

Referenced by MagBinFinders::GeneralBinFinderInZ< double >::binIndex(), and MagBinFinders::GeneralBinFinderInZ< double >::GeneralBinFinderInZ().