Trk::BinUtility Class Reference

A generic symmetric BinUtility, for fully symmetric binning in terms of binning grid and binning type. More...

#include <BinUtility.h>

Collaboration diagram for Trk::BinUtility:

Public Member Functions
	BinUtility ()
	Constructor for equidistant.
	BinUtility (const BinUtility &sbu)=default
	BinUtility (BinUtility &&sbu)=default
BinUtility &	operator= (const BinUtility &sbu)=default
BinUtility &	operator= (BinUtility &&sbu)=default
	~BinUtility ()=default
	BinUtility (size_t bins, float min, float max, BinningOption opt=open, BinningValue value=binR, float sStep=0.)
	Constructor for equidistant - the substep is for phi binning offsets.
	BinUtility (size_t subbins, float substep, float min, float max, BinningOption opt=open, BinningValue value=binR)
	Constructor for bi-equidistant.
	BinUtility (std::vector< float > &bValues, BinningOption opt=closed, BinningValue value=binPhi)
	Constructor for arbitrary.
	BinUtility (float phiRef, std::vector< std::pair< int, float > > &bValues)
	Constructor for binH.
BinUtility &	operator+= (const BinUtility &gbu)
	Operator++ to make multidimensional BinUtility.
BinUtility *	clone () const
	Implicit Constructor.
const std::vector< BinningData > &	binningData () const
	return the binning data
size_t	bin (const Amg::Vector3D &position, size_t ba=0) const
	Bin from a 3D vector (already in binning frame).
size_t	entry (const Amg::Vector3D &position, size_t ba=0) const
	Bin from a 3D vector (already in binning frame).
size_t	next (const Amg::Vector3D &position, const Amg::Vector3D &direction, size_t ba=0) const
	Bin from a 3D vector (already in binning frame).
std::pair< size_t, float >	distanceToNext (const Amg::Vector3D &position, const Amg::Vector3D &direction, size_t ba=0) const
	Distance estimate to next bin.
LayerOrder	orderDirection (const Amg::Vector3D &position, const Amg::Vector3D &direction, size_t ba=0) const
	Return the oder direciton for fast interlinking.
size_t	bin (const Amg::Vector2D &lposition, size_t ba=0) const
	Bin from a 2D vector (following local parameters defintitions).
bool	inside (const Amg::Vector3D &position) const
	Check if bin is inside from Vector3D.
bool	inside (const Amg::Vector2D &) const
	Check if bin is inside from Vector3D.
size_t	dimensions () const
	First bin maximal value.
size_t	max (size_t ba=0) const
	First bin maximal value.
size_t	bins (size_t ba=0) const
	Number of bins.
BinningValue	binningValue (size_t ba=0) const
	The type/value of the binning.
float	binPosition (size_t bin, float pos, size_t ba=0) const
	bin->BinningValue navigation : pos=+-1.
void	clear ()
	Clear the data.
MsgStream &	dump (MsgStream &sl) const
	Output Method for MsgStream, to be overloaded by child classes.
std::ostream &	dump (std::ostream &sl) const
	Output Method for std::ostream, to be overloaded by child classes.

Private Attributes
std::vector< BinningData >	m_binningData

Detailed Description

A generic symmetric BinUtility, for fully symmetric binning in terms of binning grid and binning type.

• for asymmetric binning in the binning grid use the BinnedArray1D1D
• building up a multidimensional BinUtility has to be done with the operator +=

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Definition at line 38 of file BinUtility.h.

Constructor & Destructor Documentation

BinUtility() [1/7]

Trk::BinUtility::BinUtility ( )

inline

Constructor for equidistant.

Definition at line 43 of file BinUtility.h.

               : m_binningData()
  {
    m_binningData.reserve(3);
  }

BinUtility() [2/7]

Trk::BinUtility::BinUtility ( const BinUtility & sbu )

default

BinUtility() [3/7]

Trk::BinUtility::BinUtility ( BinUtility && sbu )

default

~BinUtility()

Trk::BinUtility::~BinUtility ( )

default

BinUtility() [4/7]

Trk::BinUtility::BinUtility ( size_t bins, float min, float max, BinningOption opt = open, BinningValue value = binR, float sStep = 0. )

inline

Constructor for equidistant - the substep is for phi binning offsets.

Definition at line 55 of file BinUtility.h.

    : m_binningData()
  {
    m_binningData.reserve(3);
    std::vector<float> bValues;
    float step = (max - min) / bins;
    for (size_t ib = 0; ib <= bins; ++ib)
      bValues.push_back(min + ib * step);
    m_binningData.emplace_back(Trk::equidistant, opt, value, bins, min, max, step, sStep, bValues);
  }

BinUtility() [5/7]

Trk::BinUtility::BinUtility ( size_t subbins, float substep, float min, float max, BinningOption opt = open, BinningValue value = binR )

inline

Constructor for bi-equidistant.

Definition at line 67 of file BinUtility.h.

    : m_binningData()
  {
    m_binningData.reserve(3);
    std::vector<float> bValues;
    float step = (max - min) / (subbins + 1);
    bValues.push_back(min);
    for (size_t isb = 1; isb <= subbins; ++isb) {
      bValues.push_back(min + isb * step - substep);
      bValues.push_back(min + isb * step);
    }
    bValues.push_back(max);
    m_binningData.emplace_back(Trk::biequidistant, opt, value, 2 * subbins + 1, min, max, step, substep, bValues);
  }

BinUtility() [6/7]

Trk::BinUtility::BinUtility ( std::vector< float > & bValues, BinningOption opt = closed, BinningValue value = binPhi )

inline

Constructor for arbitrary.

Definition at line 83 of file BinUtility.h.

    : m_binningData()
  {
    m_binningData.reserve(3);
    size_t nBins = opt == 0 ? bValues.size() - 1 : bValues.size();
 
    m_binningData.emplace_back(Trk::arbitrary,
                                             opt,
                                             value,
                                             nBins,
                                             bValues[0],
                                             bValues.back(),
                                             (bValues.back() - bValues[0]) / (nBins),
                                             0.,
                                             bValues);
  }

BinUtility() [7/7]

Trk::BinUtility::BinUtility ( float phiRef, std::vector< std::pair< int, float > > & bValues )

inline

Constructor for binH.

Definition at line 101 of file BinUtility.h.

    : m_binningData()
  {
    m_binningData.reserve(3);
    m_binningData.emplace_back(Trk::open, phiRef, bValues);
  }

Member Function Documentation

bin() [1/2]

size_t Trk::BinUtility::bin ( const Amg::Vector2D & lposition, size_t ba = 0 ) const

inline

Bin from a 2D vector (following local parameters defintitions).

• USE WITH CARE !! You need to check if your local position is actually in the binning frame of the BinUtility

Definition at line 181 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      throw GaudiException("BinUtility", "dimension out of bounds", StatusCode::FAILURE);
    }
    return m_binningData[ba].searchLocal(lposition);
  }

bin() [2/2]

size_t Trk::BinUtility::bin ( const Amg::Vector3D & position, size_t ba = 0 ) const

inline

Bin from a 3D vector (already in binning frame).

Definition at line 126 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      throw GaudiException("BinUtility", "dimension out of bounds", StatusCode::FAILURE);
    }
    size_t bEval = m_binningData[ba].searchGlobal(position);
    const std::size_t b = bins(ba); //can be zero, and is unsigned
    if (b == 0){ //avoid integer overflow with b - 1
      throw GaudiException("BinUtility", "integer overflow", StatusCode::FAILURE);
    }
    return (bEval > b - 1 ? b - 1 : bEval); // ST additional protection : DEBUG source
  }

binningData()

const std::vector< BinningData > & Trk::BinUtility::binningData ( ) const

inline

return the binning data

Definition at line 123 of file BinUtility.h.

{ return m_binningData; }

binningValue()

BinningValue Trk::BinUtility::binningValue ( size_t ba = 0 ) const

inline

The type/value of the binning.

Definition at line 228 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      throw GaudiException("BinUtility", "dimension out of bounds", StatusCode::FAILURE);
    }
    return (m_binningData[ba].binvalue);
  }

binPosition()

float Trk::BinUtility::binPosition ( size_t bin, float pos, size_t ba = 0 ) const

inline

bin->BinningValue navigation : pos=+-1.

edges/ 0. bin center

Definition at line 237 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      throw GaudiException("BinUtility", "dimension out of bounds", StatusCode::FAILURE);
    }
    return (m_binningData[ba].binPosition(bin, pos));
  }

bins()

size_t Trk::BinUtility::bins ( size_t ba = 0 ) const

inline

Number of bins.

Definition at line 219 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      return 0;
    }
    return (m_binningData[ba].bins);
  }

clear()

void Trk::BinUtility::clear ( )

inline

Clear the data.

Definition at line 246 of file BinUtility.h.

{ m_binningData.clear(); }

clone()

BinUtility * Trk::BinUtility::clone ( ) const

inline

Implicit Constructor.

Definition at line 120 of file BinUtility.h.

{ return new BinUtility(*this); }

dimensions()

size_t Trk::BinUtility::dimensions ( ) const

inline

First bin maximal value.

Definition at line 207 of file BinUtility.h.

{ return m_binningData.size(); }

distanceToNext()

std::pair< size_t, float > Trk::BinUtility::distanceToNext ( const Amg::Vector3D & position, const Amg::Vector3D & direction, size_t ba = 0 ) const

inline

Distance estimate to next bin.

Definition at line 158 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      throw GaudiException("BinUtility", "dimension out of bounds", StatusCode::FAILURE);
    }
    return m_binningData[ba].distanceToNext(position, direction);
  }

dump() [1/2]

MsgStream & Trk::BinUtility::dump ( MsgStream & sl ) const

inline

Output Method for MsgStream, to be overloaded by child classes.

Definition at line 249 of file BinUtility.h.

  {
    sl << "BinUtility for " << m_binningData.size() << "-dimensional array:" << endmsg;
    std::vector<BinningData>::const_iterator bdIter = m_binningData.begin();
    for (size_t ibd = 0; bdIter != m_binningData.end(); ++bdIter, ++ibd) {
      sl << "dimension     : " << ibd << endmsg << endmsg;
      sl << " - type       : " << size_t((*bdIter).type) << endmsg;
      sl << " - option     : " << size_t((*bdIter).option) << endmsg;
      sl << " - value      : " << size_t((*bdIter).binvalue) << endmsg;
      sl << " - bins       : " << (*bdIter).bins << endmsg;
      sl << " - min/max    : " << (*bdIter).min << " / " << (*bdIter).max << endmsg;
      sl << " - step/sub   : " << (*bdIter).step << " / " << (*bdIter).subStep << endmsg;
      sl << " - boundaries : | ";
      std::vector<float>::const_iterator bIter = (*bdIter).boundaries.begin();
      for (; bIter != (*bdIter).boundaries.end(); ++bIter)
        sl << (*bIter) << " | ";
      sl << endmsg;
    }
    return sl;
  }

dump() [2/2]

std::ostream & Trk::BinUtility::dump ( std::ostream & sl ) const

inline

Output Method for std::ostream, to be overloaded by child classes.

Definition at line 271 of file BinUtility.h.

  {
    sl << "BinUtility for " << m_binningData.size() << "-dimensional array:" << std::endl;
    std::vector<BinningData>::const_iterator bdIter = m_binningData.begin();
    for (size_t ibd = 0; bdIter != m_binningData.end(); ++bdIter, ++ibd) {
      sl << "dimension     : " << ibd << std::endl;
      sl << " - type       : " << size_t((*bdIter).type) << std::endl;
      sl << " - option     : " << size_t((*bdIter).option) << std::endl;
      sl << " - value      : " << size_t((*bdIter).binvalue) << std::endl;
      sl << " - bins       : " << (*bdIter).bins << std::endl;
      sl << " - min/max    : " << (*bdIter).min << " / " << (*bdIter).max << std::endl;
      sl << " - step/sub   : " << (*bdIter).step << " / " << (*bdIter).subStep << std::endl;
      sl << " - boundaries : | ";
      std::vector<float>::const_iterator bIter = (*bdIter).boundaries.begin();
      for (; bIter != (*bdIter).boundaries.end(); ++bIter)
        sl << (*bIter) << " | ";
      sl << std::endl;
    }
    return sl;
  }

entry()

size_t Trk::BinUtility::entry ( const Amg::Vector3D & position, size_t ba = 0 ) const

inline

Bin from a 3D vector (already in binning frame).

Definition at line 140 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      throw GaudiException("BinUtility", "dimension out of bounds", StatusCode::FAILURE);
    }
    return m_binningData[ba].entry(position);
  }

inside() [1/2]

bool Trk::BinUtility::inside ( const Amg::Vector2D & ) const

inline

Check if bin is inside from Vector3D.

Definition at line 201 of file BinUtility.h.

  {
    return true;
  }

inside() [2/2]

bool Trk::BinUtility::inside ( const Amg::Vector3D & position ) const

inline

Check if bin is inside from Vector3D.

Definition at line 190 of file BinUtility.h.

  {
    std::vector<BinningData>::const_iterator bdIter = m_binningData.begin();
    for (; bdIter != m_binningData.end(); ++bdIter) {
      if (!(*bdIter).inside(position))
        return false;
    }
    return true;
  }

max()

size_t Trk::BinUtility::max ( size_t ba = 0 ) const

inline

First bin maximal value.

Definition at line 210 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      return 0;
    }
    return (m_binningData[ba].bins - 1);
  }

next()

size_t Trk::BinUtility::next ( const Amg::Vector3D & position, const Amg::Vector3D & direction, size_t ba = 0 ) const

inline

Bin from a 3D vector (already in binning frame).

Definition at line 149 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      throw GaudiException("BinUtility", "dimension out of bounds", StatusCode::FAILURE);
    }
    return m_binningData[ba].next(position, direction);
  }

operator+=()

BinUtility & Trk::BinUtility::operator+= ( const BinUtility & gbu )

inline

Operator++ to make multidimensional BinUtility.

Definition at line 109 of file BinUtility.h.

  {
    const std::vector<BinningData>& bData = gbu.binningData();
    if (m_binningData.size() + bData.size() > 3){
      throw GaudiException("BinUtility does not support dim > 3", "FATAL", StatusCode::FAILURE);
    }
    m_binningData.insert(m_binningData.end(), bData.begin(), bData.end());
    return (*this);
  }

operator=() [1/2]

BinUtility & Trk::BinUtility::operator= ( BinUtility && sbu )

default

operator=() [2/2]

BinUtility & Trk::BinUtility::operator= ( const BinUtility & sbu )

default

orderDirection()

LayerOrder Trk::BinUtility::orderDirection ( const Amg::Vector3D & position, const Amg::Vector3D & direction, size_t ba = 0 ) const

inline

Return the oder direciton for fast interlinking.

Definition at line 169 of file BinUtility.h.

  {
    if (ba >= m_binningData.size()){
      throw GaudiException("BinUtility", "dimension out of bounds", StatusCode::FAILURE);
    }
    return m_binningData[ba].orderDirection(position, direction);
  }

Member Data Documentation

m_binningData

std::vector<BinningData> Trk::BinUtility::m_binningData

private

Definition at line 293 of file BinUtility.h.

---

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

• BinUtility.h