tmtt::HTcell Class Reference

#include <HTcell.h>

Public Member Functions
void	disableBendFilter ()
void	end ()
	HTcell (const Settings *settings, unsigned int iPhiSec, unsigned int iEtaReg, float etaMinSector, float etaMaxSector, float qOverPt, unsigned int ibin_qOverPt, bool mergedCell, bool miniHTcell=false)
bool	mergedCell () const
unsigned int	numLayers () const
unsigned int	numLayersSubSec () const
unsigned int	numStubs () const
unsigned int	numUnfilteredStubs () const
void	store (Stub *stub)
void	store (Stub *stub, const std::vector< bool > &inSubSecs)
bool	stubInCell (const Stub *stub) const
const std::vector< Stub * > &	stubs () const
bool	stubStoredInCell (const Stub *stub) const
bool	trackCandFound () const

Private Member Functions
std::vector< Stub * >	bendFilter (const std::vector< Stub *> &stubs) const
unsigned int	calcNumFilteredLayers () const
unsigned int	calcNumFilteredLayers (unsigned int iSubSec) const
float	dphi (float rad) const
std::vector< Stub * >	maxStubCountFilter (const std::vector< Stub *> &stubs) const

Private Attributes
float	etaMaxSector_
float	etaMinSector_
unsigned int	ibin_qOverPt_
unsigned int	iEtaReg_
float	invPtToDphi_
unsigned int	iPhiSec_
unsigned int	maxStubsInCell_
bool	mergedCell_
bool	miniHTcell_
unsigned int	numFilteredLayersInCell_
unsigned int	numFilteredLayersInCellBestSubSec_
unsigned int	numSubSecs_
float	qOverPtCell_
const Settings *	settings_
std::map< const Stub *, std::vector< bool > >	subSectors_
bool	useBendFilter_
std::vector< Stub * >	vFilteredStubs_
std::vector< Stub * >	vStubs_

Detailed Description

Definition at line 20 of file HTcell.h.

Constructor & Destructor Documentation

HTcell()

tmtt::HTcell::HTcell	(	const Settings *	settings,
		unsigned int	iPhiSec,
		unsigned int	iEtaReg,
		float	etaMinSector,
		float	etaMaxSector,
		float	qOverPt,
		unsigned int	ibin_qOverPt,
		bool	mergedCell,
		bool	miniHTcell = false
	)

Definition at line 14 of file HTcell.cc.

References tmtt::Settings::maxStubsInCell(), maxStubsInCell_, tmtt::Settings::maxStubsInCellMiniHough(), and miniHTcell_.

      : settings_(settings),
        // Sector number
        iPhiSec_(iPhiSec),
        iEtaReg_(iEtaReg),
        // Rapidity range of sector.
        etaMinSector_(etaMinSector),
        etaMaxSector_(etaMaxSector),
        // Track q/Pt.
        qOverPtCell_(qOverPt),
        // Note bin number of cell along q/Pt axis of r-phi HT array. (Not used if r-z HT).
        ibin_qOverPt_(ibin_qOverPt),
        mergedCell_(mergedCell),
        // Is cell in Mini-HT?
        miniHTcell_(miniHTcell),
        invPtToDphi_(settings->invPtToDphi()),  // B*c/2E11
        // Use filter in each HT cell using only stubs which have consistent bend?
        useBendFilter_(settings->useBendFilter()),
        // Check if subsectors are being used within each sector. These are only ever used for r-phi HT.
        numSubSecs_(settings->numSubSecsEta()) {
    // A filter is used each HT cell, which prevents more than the specified number of stubs being stored in the cell. (Reflecting memory limit of hardware).
    if (miniHTcell_) {
      maxStubsInCell_ = settings->maxStubsInCellMiniHough();
    } else {
      maxStubsInCell_ = settings->maxStubsInCell();
    }
  }

Member Function Documentation

bendFilter()

vector< Stub * > tmtt::HTcell::bendFilter ( const std::vector< Stub *> &  stubs ) const

private

Definition at line 103 of file HTcell.cc.

References ibin_qOverPt_, cms::alpakatools::config::maxBin, mergedCell_, cms::alpakatools::config::minBin, alignCSCRings::s, and stubs().

Referenced by end().

                                                                   {
    // Create bend-filtered stub collection.
    vector<Stub*> filteredStubs;
    for (Stub* s : stubs) {
      // Require stub bend to be consistent with q/Pt of this cell.

      unsigned int minBin = s->min_qOverPt_bin();
      unsigned int maxBin = s->max_qOverPt_bin();
      if (mergedCell_) {
        if (minBin % 2 == 1)
          minBin--;
      }
      if (minBin <= ibin_qOverPt_ && ibin_qOverPt_ <= maxBin)
        filteredStubs.push_back(s);
    }

    return filteredStubs;
  }

calcNumFilteredLayers() [1/2]

unsigned int tmtt::HTcell::calcNumFilteredLayers ( ) const

inlineprivate

Definition at line 97 of file HTcell.h.

References tmtt::Utility::countLayers(), settings_, and vFilteredStubs_.

Referenced by end().

{ return Utility::countLayers(settings_, vFilteredStubs_); }

calcNumFilteredLayers() [2/2]

unsigned int tmtt::HTcell::calcNumFilteredLayers ( unsigned int  iSubSec ) const

private

Definition at line 90 of file HTcell.cc.

References tmtt::Utility::countLayers(), alignCSCRings::s, settings_, subSectors_, and vFilteredStubs_.

                                                                       {
    vector<const Stub*> stubsInSubSec;
    for (const Stub* s : vFilteredStubs_) {
      const vector<bool>& inSubSec = subSectors_.at(s);  // Find out which subsectors this stub is in.
      if (inSubSec[iSubSec])
        stubsInSubSec.push_back(s);
    }
    return Utility::countLayers(settings_, stubsInSubSec);
  }

disableBendFilter()

void tmtt::HTcell::disableBendFilter ( )

inline

Definition at line 93 of file HTcell.h.

References useBendFilter_.

Referenced by tmtt::MiniHTstage::exec().

{ useBendFilter_ = false; }

dphi()

float tmtt::HTcell::dphi ( float  rad ) const

inlineprivate

Definition at line 104 of file HTcell.h.

References invPtToDphi_, and qOverPtCell_.

{ return (invPtToDphi_ * rad * qOverPtCell_); }

end()

void tmtt::HTcell::end

(

void

)

Definition at line 52 of file HTcell.cc.

References bendFilter(), calcNumFilteredLayers(), mps_fire::i, SiStripPI::max, maxStubCountFilter(), maxStubsInCell_, numFilteredLayersInCell_, numFilteredLayersInCellBestSubSec_, numSubSecs_, useBendFilter_, vFilteredStubs_, and vStubs_.

                   {
    // Produce list of filtered stubs by applying all requested filters (e.g. on stub bend).
    // (If no filters are requested, then filtered & unfiltered stub collections will be identical).

    // N.B. Other filters,  such as the r-z filters, which the firmware runs after the HT because they are too slow within it,
    // are not defined here, but instead inside class TrkFilterAfterRphiHT.

    vFilteredStubs_ = vStubs_;
    if (useBendFilter_)
      vFilteredStubs_ = this->bendFilter(vFilteredStubs_);

    // Prevent too many stubs being stored in a single HT cell if requested (to reflect hardware memory limits).
    // N.B. This MUST be the last filter applied.
    constexpr unsigned int disableThreshold = 999;
    if (maxStubsInCell_ < disableThreshold)
      vFilteredStubs_ = this->maxStubCountFilter(vFilteredStubs_);

    // Calculate the number of layers the filtered stubs in this cell are in.
    numFilteredLayersInCell_ = this->calcNumFilteredLayers();

    if (numSubSecs_ > 1) {
      // If using subsectors within each sector, calculate the number of layers the filters stubs in this cell are in,
      // when one considers only the subset of the stubs within each subsector.
      // Look for the "best" subsector.
      numFilteredLayersInCellBestSubSec_ = 0;
      for (unsigned int i = 0; i < numSubSecs_; i++) {
        unsigned int numLaySubSec = this->calcNumFilteredLayers(i);
        numFilteredLayersInCellBestSubSec_ = max(numFilteredLayersInCellBestSubSec_, numLaySubSec);
      }
    } else {
      // If only 1 sub-sector, then subsector and sector are identical.
      numFilteredLayersInCellBestSubSec_ = numFilteredLayersInCell_;
    }
  }

maxStubCountFilter()

vector< Stub * > tmtt::HTcell::maxStubCountFilter ( const std::vector< Stub *> &  stubs ) const

private

Definition at line 125 of file HTcell.cc.

References mps_fire::i, maxStubsInCell_, and stubs().

Referenced by end().

                                                                           {
    vector<Stub*> filteredStubs;
    // If there are too many stubs in a cell, the hardware keeps (maxStubsInCell - 1) of the first stubs in the list
    // plus the last stub.
    if (stubs.size() > maxStubsInCell_) {
      for (unsigned int i = 0; i < maxStubsInCell_ - 1; i++) {  // first stubs
        filteredStubs.push_back(stubs[i]);
      }
      filteredStubs.push_back(stubs[stubs.size() - 1]);  // plus last stub
    } else {
      filteredStubs = stubs;
    }
    return filteredStubs;
  }

mergedCell()

bool tmtt::HTcell::mergedCell ( ) const

inline

Definition at line 53 of file HTcell.h.

References mergedCell_.

{ return mergedCell_; }

numLayers()

unsigned int tmtt::HTcell::numLayers ( ) const

inline

Definition at line 74 of file HTcell.h.

References numFilteredLayersInCell_.

{ return numFilteredLayersInCell_; }

numLayersSubSec()

unsigned int tmtt::HTcell::numLayersSubSec ( ) const

inline

Definition at line 76 of file HTcell.h.

References numFilteredLayersInCellBestSubSec_.

{ return numFilteredLayersInCellBestSubSec_; }

numStubs()

unsigned int tmtt::HTcell::numStubs ( ) const

inline

Definition at line 72 of file HTcell.h.

References vFilteredStubs_.

{ return vFilteredStubs_.size(); }

numUnfilteredStubs()

unsigned int tmtt::HTcell::numUnfilteredStubs ( ) const

inline

Definition at line 79 of file HTcell.h.

References vStubs_.

{ return vStubs_.size(); }  // Number of unfiltered stubs

store() [1/2]

void tmtt::HTcell::store ( Stub *  stub )

inline

Definition at line 37 of file HTcell.h.

References vStubs_.

Referenced by store().

{ vStubs_.push_back(stub); }

store() [2/2]

void tmtt::HTcell::store ( Stub *  stub, const std::vector< bool > &  inSubSecs  )

inline

Definition at line 40 of file HTcell.h.

References numSubSecs_, store(), and subSectors_.

                                                             {
      this->store(stub);
      subSectors_[stub] = inSubSecs;
      if (inSubSecs.size() != numSubSecs_)
        throw cms::Exception("LogicError") << "HTcell: Wrong number of subsectors!";
    }

stubInCell()

bool tmtt::HTcell::stubInCell ( const Stub *  stub ) const

inline

Definition at line 63 of file HTcell.h.

References submitPVResolutionJobs::count, and vFilteredStubs_.

                                            {
      return (std::count(vFilteredStubs_.begin(), vFilteredStubs_.end(), stub) > 0);
    }

stubs()

const std::vector<Stub*>& tmtt::HTcell::stubs ( ) const

inline

Definition at line 60 of file HTcell.h.

References vFilteredStubs_.

Referenced by bendFilter(), and maxStubCountFilter().

{ return vFilteredStubs_; }

stubStoredInCell()

bool tmtt::HTcell::stubStoredInCell ( const Stub *  stub ) const

inline

Definition at line 68 of file HTcell.h.

References submitPVResolutionJobs::count, and vStubs_.

{ return (std::count(vStubs_.begin(), vStubs_.end(), stub) > 0); }

trackCandFound()

bool tmtt::HTcell::trackCandFound ( ) const

inline

Definition at line 86 of file HTcell.h.

References funct::abs(), tmtt::Utility::HT, iEtaReg_, iPhiSec_, numFilteredLayersInCellBestSubSec_, tmtt::Utility::numLayerCut(), qOverPtCell_, and settings_.

                                {
      return (numFilteredLayersInCellBestSubSec_ >=
              Utility::numLayerCut(Utility::AlgoStep::HT, settings_, iPhiSec_, iEtaReg_, std::abs(qOverPtCell_)));
    }

Member Data Documentation

etaMaxSector_

float tmtt::HTcell::etaMaxSector_

private

Definition at line 122 of file HTcell.h.

etaMinSector_

float tmtt::HTcell::etaMinSector_

private

Definition at line 121 of file HTcell.h.

ibin_qOverPt_

unsigned int tmtt::HTcell::ibin_qOverPt_

private

Definition at line 127 of file HTcell.h.

Referenced by bendFilter().

iEtaReg_

unsigned int tmtt::HTcell::iEtaReg_

private

Definition at line 119 of file HTcell.h.

Referenced by trackCandFound().

invPtToDphi_

float tmtt::HTcell::invPtToDphi_

private

Definition at line 134 of file HTcell.h.

Referenced by dphi().

iPhiSec_

unsigned int tmtt::HTcell::iPhiSec_

private

Definition at line 118 of file HTcell.h.

Referenced by trackCandFound().

maxStubsInCell_

unsigned int tmtt::HTcell::maxStubsInCell_

private

Definition at line 139 of file HTcell.h.

Referenced by end(), HTcell(), and maxStubCountFilter().

mergedCell_

bool tmtt::HTcell::mergedCell_

private

Definition at line 129 of file HTcell.h.

Referenced by bendFilter(), and mergedCell().

miniHTcell_

bool tmtt::HTcell::miniHTcell_

private

Definition at line 132 of file HTcell.h.

Referenced by HTcell().

numFilteredLayersInCell_

unsigned int tmtt::HTcell::numFilteredLayersInCell_

private

Definition at line 149 of file HTcell.h.

Referenced by end(), and numLayers().

numFilteredLayersInCellBestSubSec_

unsigned int tmtt::HTcell::numFilteredLayersInCellBestSubSec_

private

Definition at line 150 of file HTcell.h.

Referenced by end(), numLayersSubSec(), and trackCandFound().

numSubSecs_

unsigned int tmtt::HTcell::numSubSecs_

private

Definition at line 142 of file HTcell.h.

Referenced by end(), and store().

qOverPtCell_

float tmtt::HTcell::qOverPtCell_

private

Definition at line 124 of file HTcell.h.

Referenced by dphi(), and trackCandFound().

settings_

const Settings* tmtt::HTcell::settings_

private

Definition at line 116 of file HTcell.h.

Referenced by calcNumFilteredLayers(), and trackCandFound().

subSectors_

std::map<const Stub*, std::vector<bool> > tmtt::HTcell::subSectors_

private

Definition at line 151 of file HTcell.h.

Referenced by calcNumFilteredLayers(), and store().

useBendFilter_

bool tmtt::HTcell::useBendFilter_

private

Definition at line 137 of file HTcell.h.

Referenced by disableBendFilter(), and end().

vFilteredStubs_

std::vector<Stub*> tmtt::HTcell::vFilteredStubs_

private

Definition at line 147 of file HTcell.h.

Referenced by calcNumFilteredLayers(), end(), numStubs(), stubInCell(), and stubs().

vStubs_

std::vector<Stub*> tmtt::HTcell::vStubs_

private

Definition at line 146 of file HTcell.h.

Referenced by end(), numUnfilteredStubs(), store(), and stubStoredInCell().