tmtt::HTbase Class Reference

#include <HTbase.h>

Inheritance diagram for tmtt::HTbase:

Public Member Functions
virtual const Array2D< std::unique_ptr< HTcell > > &	allCells () const
virtual std::vector< const L1track2D * >	assocTrackCands2D (const TP &tp) const
virtual std::pair< unsigned int, unsigned int >	cell (const L1fittedTrack *fitTrk) const =0
virtual void	disableBendFilter ()
virtual void	end ()
virtual std::pair< float, float >	helix2Dconventional (unsigned int i, unsigned int j) const =0
virtual std::pair< float, float >	helix2Dhough (unsigned int i, unsigned int j) const =0
	HTbase (const Settings *settings, unsigned int iPhiSec, unsigned int iEtaReg, unsigned int nBinsX, unsigned int nBinsY)
virtual unsigned int	numStubsExc () const
virtual unsigned int	numStubsInc () const
virtual unsigned int	numStubsOnTrackCands2D () const
virtual unsigned int	numTrackCands2D () const
virtual void	replaceTrackCands2D (const std::list< L1track2D > &newTracks)
virtual const std::list< L1track2D > &	trackCands2D () const
virtual std::pair< unsigned int, unsigned int >	trueCell (const TP *tp) const =0
virtual	~HTbase ()=default

Protected Member Functions
virtual std::pair< unsigned int, unsigned int >	convertCoordRangeToBinRange (std::pair< float, float > coordRange, unsigned int nBinsAxis, float coordAxisMin, float coordAxisBinSize, unsigned int killSomeHTcells) const

Protected Attributes
Array2D< std::unique_ptr< HTcell > >	htArray_
unsigned int	iEtaReg_
unsigned int	iPhiSec_
unsigned int	nBinsX_
unsigned int	nBinsY_
unsigned int	optoLinkID_
const Settings *	settings_
std::list< L1track2D >	trackCands2D_

Private Member Functions
virtual unsigned int	calcOptoLinkID () const
virtual std::list< L1track2D >	calcTrackCands2D () const
virtual std::list< L1track2D >	killTracksBusySec (const std::list< L1track2D > &tracks) const =0
virtual std::vector< unsigned int >	rowOrder (unsigned int numRows) const =0

Detailed Description

Definition at line 22 of file HTbase.h.

Constructor & Destructor Documentation

HTbase()

tmtt::HTbase::HTbase	(	const Settings *	settings,
		unsigned int	iPhiSec,
		unsigned int	iEtaReg,
		unsigned int	nBinsX,
		unsigned int	nBinsY
	)

Definition at line 14 of file HTbase.cc.

      : settings_(settings),
        iPhiSec_(iPhiSec),
        iEtaReg_(iEtaReg),
        nBinsX_(nBinsX),
        nBinsY_(nBinsY),
        htArray_(nBinsX, nBinsY),
        optoLinkID_(this->calcOptoLinkID()) {}

~HTbase()

virtual tmtt::HTbase::~HTbase ( )

virtualdefault

Member Function Documentation

allCells()

virtual const Array2D<std::unique_ptr<HTcell> >& tmtt::HTbase::allCells ( ) const

inlinevirtual

Definition at line 45 of file HTbase.h.

{ return htArray_; }

References htArray_.

assocTrackCands2D()

vector< const L1track2D * > tmtt::HTbase::assocTrackCands2D ( const TP &  tp ) const

virtual

Definition at line 95 of file HTbase.cc.

                                                                       {
    vector<const L1track2D*> assocRecoTrk;
 
    // Loop over track candidates, looking for those associated to given TP.
    for (const L1track2D& trk : trackCands2D_) {
      if (trk.matchedTP() != nullptr) {
        if (trk.matchedTP()->index() == tp.index())
          assocRecoTrk.push_back(&trk);
      }
    }
 
    return assocRecoTrk;
  }

References cmsswSequenceInfo::tp, and trackCands2D_.

calcOptoLinkID()

virtual unsigned int tmtt::HTbase::calcOptoLinkID ( ) const

inlineprivatevirtual

Definition at line 116 of file HTbase.h.

                                                {
      unsigned int numPhiSecPerNon = settings_->numPhiSectors() / settings_->numPhiNonants();
      return (iEtaReg_ * numPhiSecPerNon + iPhiSec_);
    }

References iEtaReg_, iPhiSec_, tmtt::Settings::numPhiNonants(), tmtt::Settings::numPhiSectors(), and settings_.

calcTrackCands2D()

list< L1track2D > tmtt::HTbase::calcTrackCands2D ( ) const

privatevirtual

Definition at line 186 of file HTbase.cc.

                                                 {
    list<L1track2D> trackCands2D;
 
    // Check if the hardware processes rows of the HT array in a specific order when outputting track candidates.
    // Currently this is by decreasing Pt for r-phi HT and unordered for r-z HT.
    const vector<unsigned int> iOrder = this->rowOrder(nBinsX_);
    bool wantOrdering = (not iOrder.empty());
 
    // Loop over cells in HT array.
    for (unsigned int i = 0; i < nBinsX_; i++) {
      // Access rows in specific order if required.
      unsigned int iPos = wantOrdering ? iOrder[i] : i;
 
      for (unsigned int j = 0; j < nBinsY_; j++) {
        if (htArray_(iPos, j)->trackCandFound()) {  // track candidate found in this cell.
 
          // Note if this corresponds to a merged HT cell (e.g. 2x2).
          const bool merged = htArray_(iPos, j)->mergedCell();
 
          // Get stubs on this track candidate.
          const vector<Stub*>& stubs = htArray_(iPos, j)->stubs();
 
          // And note location of cell inside HT array.
          const pair<unsigned int, unsigned int> cellLocation(iPos, j);
 
          // Get (q/Pt, phi0) or (tan_lambda, z0) corresponding to middle of this cell.
          const pair<float, float> helixParams2D = this->helix2Dconventional(iPos, j);
 
          // Create track and store it.
          trackCands2D.emplace_back(
              settings_, stubs, cellLocation, helixParams2D, iPhiSec_, iEtaReg_, optoLinkID_, merged);
        }
      }
    }
 
    return trackCands2D;
  }

References helix2Dconventional(), htArray_, mps_fire::i, iEtaReg_, iPhiSec_, dqmiolumiharvest::j, nBinsX_, nBinsY_, optoLinkID_, rowOrder(), settings_, and trackCands2D().

Referenced by end().

cell()

virtual std::pair<unsigned int, unsigned int> tmtt::HTbase::cell ( const L1fittedTrack *  fitTrk ) const

pure virtual

Implemented in tmtt::HTrphi.

convertCoordRangeToBinRange()

pair< unsigned int, unsigned int > tmtt::HTbase::convertCoordRangeToBinRange ( std::pair< float, float >  coordRange, unsigned int  nBinsAxis, float  coordAxisMin, float  coordAxisBinSize, unsigned int  killSomeHTcells  ) const

protectedvirtual

Definition at line 122 of file HTbase.cc.

                                                                                                           {
    float coordMin = coordRange.first;
    float coordMax = coordRange.second;
    float coordAvg = (coordRange.first + coordRange.second) / 2.;
 
    int iCoordBinMin, iCoordBinMax;
 
    //--- There are various options for doing this.
    //--- Option killSomeHTcells = 0 is the obvious one.
    //--- If killSomeHTcells > 0, then some of the cells nominally associated with the stub are killed.
 
    if (killSomeHTcells == 0) {
      // Take the full range of phi bins consistent with the stub.
      iCoordBinMin = floor((coordMin - coordAxisMin) / coordAxisBinSize);
      iCoordBinMax = floor((coordMax - coordAxisMin) / coordAxisBinSize);
    } else if (killSomeHTcells == 1) {
      // Use the reduced range of bins.
      // This algorithm, proposed by Ian, should reduce the rate, at the cost of some efficiency.
      const float fracCut = 0.3;
      iCoordBinMin = floor((coordMin - coordAxisMin) / coordAxisBinSize);
      iCoordBinMax = floor((coordMax - coordAxisMin) / coordAxisBinSize);
      unsigned int nbins = iCoordBinMax - iCoordBinMin + 1;
      if (nbins >= 2) {                                                      // Can't reduce range if already only 1 bin
        float lower = coordAxisMin + (iCoordBinMin + 1) * coordAxisBinSize;  // upper edge of lowest bin
        float upper = coordAxisMin + (iCoordBinMax)*coordAxisBinSize;        // lower edge of highest bin.
        // Calculate fractional amount of min and max bin that this stub uses.
        float extraLow = (lower - coordMin) / coordAxisBinSize;
        float extraUp = (coordMax - upper) / coordAxisBinSize;
        constexpr float small = 0.001;  // allow tolerance on floating point precision.
        if (min(extraLow, extraUp) < -small || max(extraLow, extraUp) > (1.0 + small))
          throw cms::Exception("LogicError") << "HTbase: convertCoordRangeToBinRange error";
        if (extraLow < fracCut && (nbins >= 3 || extraLow < extraUp))
          iCoordBinMin += 1;
        if (extraUp < fracCut && (nbins >= 3 || extraUp < extraLow))
          iCoordBinMax -= 1;
      }
    } else if (killSomeHTcells == 2) {
      // This corresponds to Thomas's firmware implementation, which can't fill more than one HT cell per column.
      iCoordBinMin = floor((coordAvg - coordAxisMin) / coordAxisBinSize);
      iCoordBinMax = iCoordBinMin;
    } else {
      throw cms::Exception("BadConfig") << "HT: invalid KillSomeHTCells option in cfg";
    }
 
    // Limit range to dimensions of HT array.
    iCoordBinMin = max(iCoordBinMin, 0);
    iCoordBinMax = min(iCoordBinMax, int(nBinsAxis) - 1);
 
    // If whole range is outside HT array, flag this by setting range to specific values with min > max.
    if (iCoordBinMin > int(nBinsAxis) - 1 || iCoordBinMax < 0) {
      iCoordBinMin = int(nBinsAxis) - 1;
      iCoordBinMax = 0;
    }
 
    return pair<unsigned int, unsigned int>(iCoordBinMin, iCoordBinMax);
  }

References Exception, createfilelist::int, SiStripPI::max, min(), LaserClient_cfi::nbins, and pileupCalc::upper.

Referenced by tmtt::HTrphi::iPhiRange().

disableBendFilter()

void tmtt::HTbase::disableBendFilter ( )

virtual

Definition at line 111 of file HTbase.cc.

                                 {
    // Loop over cells in HT array.
    for (unsigned int i = 0; i < nBinsX_; i++) {
      for (unsigned int j = 0; j < nBinsY_; j++) {
        htArray_(i, j)->disableBendFilter();
      }
    }
  }

References htArray_, mps_fire::i, dqmiolumiharvest::j, nBinsX_, and nBinsY_.

end()

void tmtt::HTbase::end ( void  )

virtual

Definition at line 26 of file HTbase.cc.

                   {
    // Calculate useful info about each cell in array.
    for (unsigned int i = 0; i < nBinsX_; i++) {
      for (unsigned int j = 0; j < nBinsY_; j++) {
        htArray_(i, j)->end();  // Calls HTcell::end()
      }
    }
 
    // Produce a list of all track candidates found in this array, each containing all the stubs on each one
    // and the track helix parameters, plus the associated truth particle (if any).
    trackCands2D_ = this->calcTrackCands2D();
 
    // If requested, kill those tracks in this sector that can't be read out during the time-multiplexed period, because
    // the HT has associated too many stubs to tracks.
    if (settings_->busySectorKill()) {
      trackCands2D_ = this->killTracksBusySec(trackCands2D_);
    }
  }

References tmtt::Settings::busySectorKill(), calcTrackCands2D(), htArray_, mps_fire::i, dqmiolumiharvest::j, killTracksBusySec(), nBinsX_, nBinsY_, settings_, and trackCands2D_.

helix2Dconventional()

virtual std::pair<float, float> tmtt::HTbase::helix2Dconventional ( unsigned int  i, unsigned int  j  ) const

pure virtual

Implemented in tmtt::HTrphi.

Referenced by calcTrackCands2D().

helix2Dhough()

virtual std::pair<float, float> tmtt::HTbase::helix2Dhough ( unsigned int  i, unsigned int  j  ) const

pure virtual

Implemented in tmtt::HTrphi.

killTracksBusySec()

virtual std::list<L1track2D> tmtt::HTbase::killTracksBusySec ( const std::list< L1track2D > &  tracks ) const

privatepure virtual

Implemented in tmtt::HTrphi.

Referenced by end().

numStubsExc()

unsigned int tmtt::HTbase::numStubsExc ( ) const

virtual

Definition at line 62 of file HTbase.cc.

                                         {
    unordered_set<unsigned int> stubIDs;  // Each ID stored only once, no matter how often it is added.
 
    // Loop over cells in HT array.
    for (unsigned int i = 0; i < nBinsX_; i++) {
      for (unsigned int j = 0; j < nBinsY_; j++) {
        // Loop over stubs in each cells, storing their IDs.
        const vector<Stub*>& vStubs = htArray_(i, j)->stubs();  // Calls HTcell::stubs()
        for (const Stub* stub : vStubs) {
          stubIDs.insert(stub->index());
        }
      }
    }
 
    return stubIDs.size();
  }

References htArray_, mps_fire::i, dqmiolumiharvest::j, nBinsX_, and nBinsY_.

numStubsInc()

unsigned int tmtt::HTbase::numStubsInc ( ) const

virtual

Definition at line 47 of file HTbase.cc.

                                         {
    unsigned int nStubs = 0;
 
    // Loop over cells in HT array.
    for (unsigned int i = 0; i < nBinsX_; i++) {
      for (unsigned int j = 0; j < nBinsY_; j++) {
        nStubs += htArray_(i, j)->numStubs();  // Calls HTcell::numStubs()
      }
    }
 
    return nStubs;
  }

References htArray_, mps_fire::i, dqmiolumiharvest::j, nBinsX_, and nBinsY_.

numStubsOnTrackCands2D()

unsigned int tmtt::HTbase::numStubsOnTrackCands2D ( ) const

virtual

Definition at line 81 of file HTbase.cc.

                                                    {
    unsigned int nStubs = 0;
 
    // Loop over track candidates
    for (const L1track2D& trk : trackCands2D_) {
      nStubs += trk.stubs().size();
    }
 
    return nStubs;
  }

References trackCands2D_.

numTrackCands2D()

virtual unsigned int tmtt::HTbase::numTrackCands2D ( ) const

inlinevirtual

Definition at line 58 of file HTbase.h.

{ return trackCands2D_.size(); }

References trackCands2D_.

replaceTrackCands2D()

virtual void tmtt::HTbase::replaceTrackCands2D ( const std::list< L1track2D > &  newTracks )

inlinevirtual

Definition at line 70 of file HTbase.h.

{ trackCands2D_ = newTracks; }

References trackCands2D_.

Referenced by tmtt::MiniHTstage::exec(), and tmtt::MuxHToutputs::exec().

rowOrder()

virtual std::vector<unsigned int> tmtt::HTbase::rowOrder ( unsigned int  numRows ) const

privatepure virtual

Implemented in tmtt::HTrphi.

Referenced by calcTrackCands2D().

trackCands2D()

virtual const std::list<L1track2D>& tmtt::HTbase::trackCands2D ( ) const

inlinevirtual

Definition at line 54 of file HTbase.h.

{ return trackCands2D_; }

References trackCands2D_.

Referenced by calcTrackCands2D(), tmtt::MiniHTstage::exec(), tmtt::MuxHToutputs::exec(), and tmtt::TMTrackProducer::produce().

trueCell()

virtual std::pair<unsigned int, unsigned int> tmtt::HTbase::trueCell ( const TP *  tp ) const

pure virtual

Implemented in tmtt::HTrphi.

Member Data Documentation

htArray_

Array2D<std::unique_ptr<HTcell> > tmtt::HTbase::htArray_

protected

Definition at line 132 of file HTbase.h.

Referenced by allCells(), calcTrackCands2D(), disableBendFilter(), end(), tmtt::HTrphi::HTrphi(), numStubsExc(), numStubsInc(), and tmtt::HTrphi::store().

iEtaReg_

unsigned int tmtt::HTbase::iEtaReg_

protected

Definition at line 125 of file HTbase.h.

Referenced by calcOptoLinkID(), and calcTrackCands2D().

iPhiSec_

unsigned int tmtt::HTbase::iPhiSec_

protected

Definition at line 124 of file HTbase.h.

Referenced by calcOptoLinkID(), and calcTrackCands2D().

nBinsX_

unsigned int tmtt::HTbase::nBinsX_

protected

Definition at line 127 of file HTbase.h.

Referenced by calcTrackCands2D(), disableBendFilter(), end(), numStubsExc(), and numStubsInc().

nBinsY_

unsigned int tmtt::HTbase::nBinsY_

protected

Definition at line 128 of file HTbase.h.

Referenced by calcTrackCands2D(), disableBendFilter(), end(), numStubsExc(), and numStubsInc().

optoLinkID_

unsigned int tmtt::HTbase::optoLinkID_

protected

Definition at line 134 of file HTbase.h.

Referenced by calcTrackCands2D().

settings_

const Settings* tmtt::HTbase::settings_

protected

Definition at line 122 of file HTbase.h.

Referenced by calcOptoLinkID(), calcTrackCands2D(), end(), and tmtt::HTrphi::HTrphi().

trackCands2D_

std::list<L1track2D> tmtt::HTbase::trackCands2D_

protected

Definition at line 139 of file HTbase.h.

Referenced by assocTrackCands2D(), end(), numStubsOnTrackCands2D(), numTrackCands2D(), replaceTrackCands2D(), and trackCands2D().