tmtt::MuxHToutputs Class Reference

#include <MuxHToutputs.h>

Public Types
enum	MuxAlgoName { MuxAlgoName::None = 0, MuxAlgoName::mBinPerLink = 1 }

Public Member Functions
void	exec (Array2D< std::unique_ptr< HTrphi >> &mHtRphis) const
	MuxHToutputs (const Settings *settings)
unsigned int	numLinksPerNonant () const

Private Member Functions
unsigned int	linkID (unsigned int iSecInNon, unsigned int iEtaReg, unsigned int mBinRange) const
unsigned int	muxFactor () const
void	sanityCheck ()

Private Attributes
bool	busySectorKill_
std::vector< unsigned int >	busySectorMbinRanges_
unsigned int	busySectorNumStubs_
bool	busySectorUseMbinRanges_
MuxAlgoName	muxOutputsHT_
unsigned int	numEtaRegions_
unsigned int	numPhiNonants_
unsigned int	numPhiSecPerNon_
unsigned int	numPhiSectors_
const Settings *	settings_

Detailed Description

Definition at line 27 of file MuxHToutputs.h.

Member Enumeration Documentation

MuxAlgoName

enum tmtt::MuxHToutputs::MuxAlgoName

strong

Enumerator
None
mBinPerLink

Definition at line 29 of file MuxHToutputs.h.

{ None = 0, mBinPerLink = 1 };

Constructor & Destructor Documentation

MuxHToutputs()

tmtt::MuxHToutputs::MuxHToutputs

(

const Settings *

settings

)

Definition at line 19 of file MuxHToutputs.cc.

References busySectorUseMbinRanges_, Exception, numLinksPerNonant(), numPhiNonants_, numPhiSectors_, sanityCheck(), submitPVValidationJobs::t, and submitPVValidationJobs::text.

      : settings_(settings),
        muxOutputsHT_(static_cast<MuxAlgoName>(settings_->muxOutputsHT())),
        numPhiNonants_(settings_->numPhiNonants()),
        numPhiSectors_(settings_->numPhiSectors()),
        numPhiSecPerNon_(numPhiSectors_ / numPhiNonants_),
        numEtaRegions_(settings_->numEtaRegions()),
        busySectorKill_(settings_->busySectorKill()),          // Kill excess tracks flowing out of HT?
        busySectorNumStubs_(settings_->busySectorNumStubs()),  // Max. num. of stubs that can be sent within TM period
        busySectorMbinRanges_(
            settings_->busySectorMbinRanges()),  // Individual m bin (=q/Pt) ranges to be output to opto-links.
        busySectorUseMbinRanges_(not busySectorMbinRanges_.empty())  // m bin ranges option disabled if vector empty.
  {
    // Implemented MUX algorithm relies on same number of sectors per nonant.
    if (numPhiSectors_ % numPhiNonants_ != 0)
      throw cms::Exception("BadConfig")
          << "MuxHToutputs: Number of phi sectors is not a multiple of number of nonants!";

    if (!busySectorUseMbinRanges_)
      throw cms::Exception("BadConfig") << "MuxHToutputs: The implemented MUX algorithm requires you to be using the "
                                           "busySectorMbinRanges cfg option!";

    // Check that the MUX algorithm implemented in linkID() is not obviously wrong.
    this->sanityCheck();

    std::stringstream text;
    text << "=== The R-PHI HT output is multiplexed onto " << this->numLinksPerNonant()
         << " pairs of opto-links per nonant.";
    static std::once_flag printOnce;
    std::call_once(
        printOnce, [](string t) { PrintL1trk() << t; }, text.str());
  }

Member Function Documentation

exec()

void tmtt::MuxHToutputs::exec

(

Array2D< std::unique_ptr< HTrphi >> &

mHtRphis

)

const

Definition at line 57 of file MuxHToutputs.cc.

References busySectorKill_, busySectorNumStubs_, tmtt::HTrphi::getMbinRange(), runTheMatrix::keep, MainPageGenerator::link, linkID(), numEtaRegions_, numLinksPerNonant(), numPhiNonants_, numPhiSecPerNon_, tmtt::L1track2D::numStubs(), tmtt::HTbase::replaceTrackCands2D(), tmtt::L1track2D::setOptoLinkID(), tmtt::HTbase::trackCands2D(), and tracks.

Referenced by tmtt::TMTrackProducer::produce().

                                                                     {
    // As this loops over sectors in order of increasing sector number, this MUX algorithm always transmits tracks
    // from the lowest sector numbers on each link first. So the highest sector numbers are more likely to be
    // truncated by the TM period. The algorithm assumes that two or more m-bin ranges from the same sector will never
    // be transmitted down the same link, as if this happens, it does not predict the order in which they will be
    // transmitted.

    for (unsigned int iPhiNon = 0; iPhiNon < numPhiNonants_; iPhiNon++) {
      vector<unsigned int> numStubsPerLink(this->numLinksPerNonant(), 0);

      for (unsigned int iSecInNon = 0; iSecInNon < numPhiSecPerNon_; iSecInNon++) {
        unsigned int iPhiSec = iPhiNon * numPhiSecPerNon_ + iSecInNon;

        for (unsigned int iEtaReg = 0; iEtaReg < numEtaRegions_; iEtaReg++) {
          HTrphi* htRphi = mHtRphis(iPhiSec, iEtaReg).get();  // Get a mutable version of the r-phi HT.

          list<L1track2D> keptTracks;
          const list<L1track2D>& tracks = htRphi->trackCands2D();

          for (const L1track2D& trk : tracks) {
            L1track2D trkTmp = trk;
            unsigned int nStubs = trkTmp.numStubs();                // #stubs on this track.
            unsigned int mBinRange = htRphi->getMbinRange(trkTmp);  // Which m bin range is this track in?
            // Get the output optical link corresponding to this sector & m-bin range.
            unsigned int link = this->linkID(iSecInNon, iEtaReg, mBinRange);
            // Make a note of opto-link number inside track object.
            trkTmp.setOptoLinkID(link);

            numStubsPerLink[link] += nStubs;
            // Check if this track can be output within the time-multiplexed period.
            bool keep = ((not busySectorKill_) || (numStubsPerLink[link] <= busySectorNumStubs_));
            // FIX: with 2 GeV threshold, this causes significant truncation.
            // Consider using one output link for each phi sector in nonant
            if (keep)
              keptTracks.push_back(trkTmp);
          }

          // Replace the collection of 2D tracks in the r-phi HT with the subset of them surviving the TM cut.
          htRphi->replaceTrackCands2D(keptTracks);
        }
      }
    }
  }

linkID()

unsigned int tmtt::MuxHToutputs::linkID ( unsigned int  iSecInNon, unsigned int  iEtaReg, unsigned int  mBinRange  ) const

private

Definition at line 114 of file MuxHToutputs.cc.

References Exception, MainPageGenerator::link, mBinPerLink, muxOutputsHT_, and numLinksPerNonant().

Referenced by exec(), and sanityCheck().

                                                                                                              {
    unsigned int link;

    if (muxOutputsHT_ == MuxAlgoName::mBinPerLink) {
      //--- This is the Sept. 2019 Mux for the transverse HT readout organised by m-bin. (Each m bin in entire nonant goes to a different link).

      link = 0;
      link += mBinRange;

    } else {
      throw cms::Exception("BadConfig") << "MuxHToutputs: Unknown MuxOutputsHT configuration option!";
    }

    if (link >= this->numLinksPerNonant())
      throw cms::Exception("LogicError") << "MuxHToutputs: Calculated link ID exceeded expected number of links! "
                                         << link << " " << this->numLinksPerNonant();
    return link;
  }

muxFactor()

unsigned int tmtt::MuxHToutputs::muxFactor ( ) const

private

Definition at line 103 of file MuxHToutputs.cc.

References Exception, mBinPerLink, muxOutputsHT_, numEtaRegions_, and numPhiSecPerNon_.

Referenced by numLinksPerNonant(), and sanityCheck().

                                             {
    if (muxOutputsHT_ == MuxAlgoName::mBinPerLink) {
      return numEtaRegions_ * numPhiSecPerNon_;
    } else {
      throw cms::Exception("BadConfig") << "MuxHToutputs: Unknown MuxOutputsHT configuration option!";
    }
  }

numLinksPerNonant()

unsigned int tmtt::MuxHToutputs::numLinksPerNonant ( ) const

inline

Definition at line 42 of file MuxHToutputs.h.

References busySectorMbinRanges_, tmtt::Settings::miniHTstage(), muxFactor(), numEtaRegions_, numPhiSecPerNon_, and settings_.

Referenced by exec(), linkID(), MuxHToutputs(), and sanityCheck().

                                           {
      unsigned int iCorr = (settings_->miniHTstage()) ? 1 : 0;
      return numPhiSecPerNon_ * numEtaRegions_ * (busySectorMbinRanges_.size() - iCorr) / this->muxFactor();
    }

sanityCheck()

void tmtt::MuxHToutputs::sanityCheck ( )

private

Definition at line 135 of file MuxHToutputs.cc.

References busySectorMbinRanges_, Exception, MainPageGenerator::link, linkID(), tmtt::Settings::miniHTstage(), muxFactor(), numEtaRegions_, numLinksPerNonant(), numPhiSecPerNon_, and settings_.

Referenced by MuxHToutputs().

                                 {
    if (numPhiSecPerNon_ * numEtaRegions_ % this->muxFactor() != 0)
      throw cms::Exception("LogicError")
          << "MuxHToutputs: Number of sectors per phi nonant is not a multiple of muxFactor().";

    vector<unsigned int> nObsElementsPerLink(this->numLinksPerNonant(), 0);
    for (unsigned int iSecInNon = 0; iSecInNon < numPhiSecPerNon_; iSecInNon++) {
      for (unsigned int iEtaReg = 0; iEtaReg < numEtaRegions_; iEtaReg++) {
        unsigned int iCorr = (settings_->miniHTstage()) ? 1 : 0;
        for (unsigned int mBinRange = 0; mBinRange < busySectorMbinRanges_.size() - iCorr; mBinRange++) {
          unsigned int link = this->linkID(iSecInNon, iEtaReg, mBinRange);
          nObsElementsPerLink[link] += 1;
        }
      }
    }
  }

Member Data Documentation

busySectorKill_

bool tmtt::MuxHToutputs::busySectorKill_

private

Definition at line 67 of file MuxHToutputs.h.

Referenced by exec().

busySectorMbinRanges_

std::vector<unsigned int> tmtt::MuxHToutputs::busySectorMbinRanges_

private

Definition at line 69 of file MuxHToutputs.h.

Referenced by numLinksPerNonant(), and sanityCheck().

busySectorNumStubs_

unsigned int tmtt::MuxHToutputs::busySectorNumStubs_

private

Definition at line 68 of file MuxHToutputs.h.

Referenced by exec().

busySectorUseMbinRanges_

bool tmtt::MuxHToutputs::busySectorUseMbinRanges_

private

Definition at line 70 of file MuxHToutputs.h.

Referenced by MuxHToutputs().

muxOutputsHT_

MuxAlgoName tmtt::MuxHToutputs::muxOutputsHT_

private

Definition at line 62 of file MuxHToutputs.h.

Referenced by linkID(), and muxFactor().

numEtaRegions_

unsigned int tmtt::MuxHToutputs::numEtaRegions_

private

Definition at line 66 of file MuxHToutputs.h.

Referenced by exec(), muxFactor(), numLinksPerNonant(), and sanityCheck().

numPhiNonants_

unsigned int tmtt::MuxHToutputs::numPhiNonants_

private

Definition at line 63 of file MuxHToutputs.h.

Referenced by exec(), and MuxHToutputs().

numPhiSecPerNon_

unsigned int tmtt::MuxHToutputs::numPhiSecPerNon_

private

Definition at line 65 of file MuxHToutputs.h.

Referenced by exec(), muxFactor(), numLinksPerNonant(), and sanityCheck().

numPhiSectors_

unsigned int tmtt::MuxHToutputs::numPhiSectors_

private

Definition at line 64 of file MuxHToutputs.h.

Referenced by MuxHToutputs().

settings_

const Settings* tmtt::MuxHToutputs::settings_

private

Definition at line 59 of file MuxHToutputs.h.

Referenced by numLinksPerNonant(), and sanityCheck().