LVL1::RecJetRoI Class Reference

This class defines the reconstructed em/tau hadron ROI. More...

#include <RecJetRoI.h>

Inheritance diagram for LVL1::RecJetRoI:

Collaboration diagram for LVL1::RecJetRoI:

Public Member Functions
	RecJetRoI ()
	RecJetRoI (unsigned int RoIWord, const std::vector< TrigConf::TriggerThreshold * > *caloThresholds)
	The constructor doesn't do much - all the work is in the "construct" methods. More...
	RecJetRoI (unsigned int RoIWord, const TrigConf::L1Menu *const l1menu)
	constructor using Run 3 configuration More...
	RecJetRoI (const RecJetRoI &obj)
RecJetRoI &	operator= (RecJetRoI const &obj)
	~RecJetRoI ()
virtual unsigned int	roiWord () const
	returns roi word More...
virtual double	phi () const
	returns phi coord of ROI More...
virtual double	eta () const
	returns eta coord of ROI More...
virtual unsigned int	crate () const
	returns JEP crate number More...
virtual unsigned int	module () const
	returns JEM number More...
virtual unsigned int	frame () const
	returns RoI frame number More...
virtual unsigned int	localcoord () const
	returns local coordinate within frame More...
virtual unsigned int	etLarge () const
	returns roi ET in larger cluster. More...
virtual unsigned int	etSmall () const
	returns roi ET in smaller cluster. More...
bool	passedThreshold (unsigned int thresholdNumber) const
	returns TRUE if threshold number threshold_number has been passed by this ROI. More...
bool	passedFwdThreshold (unsigned int thresholdNumber) const
	Same for forward jets. More...
CoordinateRange	coord () const
	returns the CoordinateRange. More...
std::vector< unsigned int >	thresholdsPassed () const
	returns a vector of thresholds passed. More...
unsigned int	triggerThreshold (unsigned int thresh) const
	returns the value of the trigger threshold for the threshold passed. More...
unsigned int	windowSize (unsigned int thresh) const
	returns the size of the window. More...
unsigned int	thresholdPattern () const
	returns bitmask of passed thresholds More...
bool	isValidThreshold (unsigned int thresh) const
	returns true if thresh is a valid threshold number More...
bool	isForwardJet () const
	returns true if the RoI is a forward jet RoI. More...

Private Member Functions
void	constructRun1 (const std::vector< TrigConf::TriggerThreshold * > *caloThresholds)
	The "construct" calls unpack the RoIWord and copy information about the passed thresholds from the vector of TriggerThresholds into maps for later retrieval. More...
void	constructRun2 (const std::vector< TrigConf::TriggerThreshold * > *caloThresholds)
	construct call for Run 2 Jet RoIs More...
void	constructRun3 (const TrigConf::L1Menu *const l1menu)

Private Attributes
unsigned long int	m_roiWord { 0 }
	this is the actual format of the data sent from the LVL1 hardware. More...
JEPRoIDecoder *	m_decoder { 0 }
	Used for decoding RoI word. More...
int	m_version { 0 }
	Store the RoI format version. More...
CoordinateRange	m_coordRange
	this contains the coordinate range worked out from the RoIWord hardware coord (i.e. More...
unsigned long int	m_thresholdMask { 0 }
	Information on trigger thresholds passed by RoI. More...
std::map< unsigned int, unsigned int >	m_triggerThresholdValue
std::map< unsigned int, unsigned int >	m_windowSize

Detailed Description

This class defines the reconstructed em/tau hadron ROI.

It is generated from the Slink output of TrigT1Calo.

Author

Edward Moyse

Definition at line 39 of file RecJetRoI.h.

Constructor & Destructor Documentation

RecJetRoI() [1/4]

LVL1::RecJetRoI::RecJetRoI ( )

inline

Definition at line 43 of file RecJetRoI.h.

{}

RecJetRoI() [2/4]

LVL1::RecJetRoI::RecJetRoI	(	unsigned int	RoIWord,
		const std::vector< TrigConf::TriggerThreshold * > *	caloThresholds
	)

The constructor doesn't do much - all the work is in the "construct" methods.

Definition at line 29 of file RecJetRoI.cxx.

                                                                                 {
 
  m_roiWord = RoIWord;
  m_decoder = new JEPRoIDecoder();
  m_version = m_decoder->jetRoIVersion(m_roiWord);
  m_coordRange = m_decoder->coordinate(m_roiWord);
 
  if (m_version > 1)
    this->constructRun2(caloThresholds);
  else
    this->constructRun1(caloThresholds);
}

RecJetRoI() [3/4]

LVL1::RecJetRoI::RecJetRoI	(	unsigned int	RoIWord,
		const TrigConf::L1Menu *const	l1menu
	)

constructor using Run 3 configuration

Definition at line 43 of file RecJetRoI.cxx.

                                                                 :
  m_roiWord(RoIWord),
  m_decoder(new JEPRoIDecoder()),
  m_version(m_decoder->jetRoIVersion(m_roiWord)),
  m_coordRange(m_decoder->coordinate(m_roiWord))
{
  constructRun3(l1menu);
}

RecJetRoI() [4/4]

LVL1::RecJetRoI::RecJetRoI

(

const RecJetRoI &

obj

)

Definition at line 54 of file RecJetRoI.cxx.

                                               :
   m_roiWord(obj.m_roiWord),
   m_decoder(new JEPRoIDecoder()),
   m_version(obj.m_version),
   m_coordRange(obj.m_coordRange),
   m_triggerThresholdValue(obj.m_triggerThresholdValue),
   m_windowSize(obj.m_windowSize)
{}

~RecJetRoI()

LVL1::RecJetRoI::~RecJetRoI

(

)

Definition at line 79 of file RecJetRoI.cxx.

{ delete m_decoder; }

Member Function Documentation

constructRun1()

void LVL1::RecJetRoI::constructRun1 ( const std::vector< TrigConf::TriggerThreshold * > *  caloThresholds )

private

The "construct" calls unpack the RoIWord and copy information about the passed thresholds from the vector of TriggerThresholds into maps for later retrieval.

One warning here: the methods of the RecRoI classes assume threshold numbering starts at 1, rather than 0 in the calorimeter trigger simulation and Lvl1ConfigSvc. Hence the odd "-1" in a couple of places in these classes construct call for Run 1 Jet RoIs

Definition at line 90 of file RecJetRoI.cxx.

{
 
   m_thresholdMask = m_roiWord & 0xfff;
 
   std::string jetTriggerType = L1DataDef::jetType();
   if (this->isForwardJet())
      jetTriggerType =
          ((this->eta() > 0) ? L1DataDef::jfType() : L1DataDef::jbType());
 
   //
   // Copy the thresholds into a map - makes matching up the passed ones very
   // easy
   //
 
   std::map<unsigned int, TriggerThreshold *> thrMap;
   for (std::vector<TriggerThreshold *>::const_iterator it =
            caloThresholds->begin();
        it != caloThresholds->end(); ++it)
   {
      if ((*it)->type() == jetTriggerType)
      {
         unsigned int num = static_cast<unsigned int>((*it)->thresholdNumber());
         thrMap.insert(std::map<unsigned int, TriggerThreshold *>::value_type(num, (*it)));
      }
   }
 
   //
   // Extract the properties of the passed thresholds:
   //
   const vector<unsigned int> passed_thresholds =
       (this->isForwardJet() ? m_decoder->fwdThresholdsPassed(m_roiWord)
                             : m_decoder->thresholdsPassed(m_roiWord));
 
   int iphi = int((m_coordRange.phiRange().min() + 0.025) * 32 / M_PI);
   int ieta =
       int((this->eta() + ((this->eta() > 0.01) ? 0.025 : -0.025)) / 0.1) - 1;
   // Adjustment due to irregular geometries
   if (ieta > 24)
      ieta += 2;
 
   for (vector<unsigned int>::const_iterator itp = passed_thresholds.begin();
        itp != passed_thresholds.end(); ++itp)
   {
      std::map<unsigned int, TriggerThreshold *>::const_iterator thr =
          thrMap.find(*itp - 1);
      if (thr != thrMap.end())
      {
         TriggerThresholdValue *ttv =
             thr->second->triggerThresholdValue(ieta, iphi);
         JetThresholdValue *jtv = dynamic_cast<JetThresholdValue *>(ttv);
         if (jtv)
         {
            m_triggerThresholdValue.insert(std::map<unsigned int, unsigned int>::value_type(
                *itp, jtv->thresholdValueCount()));
            m_windowSize.insert(
                std::map<unsigned int, unsigned int>::value_type(*itp, jtv->window()));
         }
      } // end "found threshold in map"
   }    // end loop through passed thresholds
 
   return;
}

constructRun2()

void LVL1::RecJetRoI::constructRun2 ( const std::vector< TrigConf::TriggerThreshold * > *  caloThresholds )

private

construct call for Run 2 Jet RoIs

Definition at line 156 of file RecJetRoI.cxx.

{
 
  m_thresholdMask = 0;
  m_triggerThresholdValue.clear();
  m_windowSize.clear();
 
  int ieta =
      int((this->eta() + ((this->eta() > 0.01) ? 0.025 : -0.025)) / 0.1) - 1;
  // Adjustment due to irregular geometries
  if (ieta > 24)
    ieta += 2;
  int iphi = int((m_coordRange.phiRange().min() + 0.025) * 32 / M_PI);
  //
  // Iterate through vector of thresholds and see which ones this RoI satisfies
  //
  for (std::vector<TriggerThreshold *>::const_iterator it =
           caloThresholds->begin();
       it != caloThresholds->end(); ++it) {
    if ((*it)->type() == L1DataDef::jetType()) {
      // Does it satisfy this one?
      // Start by extracting threshold values
      TriggerThresholdValue *ttv = (*it)->triggerThresholdValue(ieta, iphi);
      JetThresholdValue *jtv = dynamic_cast<JetThresholdValue *>(ttv);
      if (jtv) {
        float scale = jtv->caloInfo().globalJetScale();
        unsigned int etCut = jtv->ptcut();
        unsigned int threshold = etCut * scale;
        JetWindowSize::Size window = jtv->windowSize();
        unsigned int roiET =
            (window == JetWindowSize::LARGE ? etLarge() : etSmall());
        if (roiET > threshold) {
          unsigned int num = static_cast<unsigned int>((*it)->thresholdNumber());
          m_triggerThresholdValue.insert(
              std::map<unsigned int, unsigned int>::value_type(num, etCut));
          m_windowSize.insert(
              std::map<unsigned int, unsigned int>::value_type(num, window));
          m_thresholdMask |= (1 << num);
        } // passes cuts
      }   // JetThresholdValue pointer valid
    }     // correct threshold type
  }       // Loop over thresholds
}

constructRun3()

void LVL1::RecJetRoI::constructRun3 ( const TrigConf::L1Menu *const  l1menu )

private

Definition at line 201 of file RecJetRoI.cxx.

{
   int ieta = int((this->eta() + ((this->eta() > 0.01) ? 0.025 : -0.025)) / 0.1) - 1;
   // Adjustment due to irregular geometries
   if (ieta > 24)
   {
      ieta += 2;
   }
 
   // Iterate through vector of thresholds and see which ones this RoI satisfies
   for (const shared_ptr<TrigConf::L1Threshold> &thr : l1menu->thresholds("JET"))
   {
      // Does it satisfy this one?
      // Start by extracting threshold values
      auto jetThr = dynamic_cast<TrigConf::L1Threshold_JET*>(thr.get());
      if (!jetThr)
      {
         continue;
      }
 
      // test eT
      unsigned int etCut = std::round(jetThr->thrValue(ieta)); // threshold value in GeV (integer for legacy thr)
      unsigned int etCounts = jetThr->thrValueCounts(ieta);    // threshold counts (threshold value * emscale)
      TrigConf::JetWindowSize::Size window = (jetThr->window() == 8) ? TrigConf::JetWindowSize::LARGE : TrigConf::JetWindowSize::SMALL;
      unsigned int roiET = (window == TrigConf::JetWindowSize::LARGE) ? RecJetRoI::etLarge() : RecJetRoI::etSmall();
      bool eTPassed = (roiET > etCounts);
 
      if (eTPassed)
      {
         const unsigned int num = thr->mapping();
         m_triggerThresholdValue[num] = etCut;
         m_windowSize[num] = window;
         m_thresholdMask |= (1 << num);
      } // passes cuts
   }    // Loop over thresholds
}

coord()

LVL1::CoordinateRange LVL1::RecJetRoI::coord

(

)

const

returns the CoordinateRange.

This is worked out from the RoIWord's hardware coords (i.e. crate number, CPM number etc.) by the RoIDecoder class.

Definition at line 348 of file RecJetRoI.cxx.

{ return m_coordRange; }

crate()

unsigned int LVL1::RecJetRoI::crate ( ) const

virtual

returns JEP crate number

returns crate number of ROI

Definition at line 257 of file RecJetRoI.cxx.

{ return m_decoder->crate(m_roiWord); }

eta()

double LVL1::RecJetRoI::eta ( ) const

virtual

returns eta coord of ROI

Implements iRecCoordRoI.

Definition at line 253 of file RecJetRoI.cxx.

{ return m_coordRange.eta(); }

etLarge()

unsigned int LVL1::RecJetRoI::etLarge ( ) const

virtual

returns roi ET in larger cluster.

returns ET of ROI large cluster.

Only valid for Run 2 data. Will return highest threshold passed if called for Run 1 data.

For Run 1 will return highest threshold passed irrespective of size

Definition at line 282 of file RecJetRoI.cxx.

                             {
  if (m_version > 1) {
    return m_decoder->etLarge(m_roiWord);
  } else {
    float highest = 0;
    std::map<unsigned int, unsigned int>::const_iterator it =
        m_triggerThresholdValue.begin();
    for (; it != m_triggerThresholdValue.end(); ++it)
      if (it->second > highest)
        highest = it->second;
    return highest;
  }
}

etSmall()

unsigned int LVL1::RecJetRoI::etSmall ( ) const

virtual

returns roi ET in smaller cluster.

returns ET of ROI small cluster.

Only valid for Run 2 data. Will return highest threshold passed if called for Run 1 data.

For Run 1 will return highest threshold passed irrespective of size

Definition at line 299 of file RecJetRoI.cxx.

                             {
  if (m_version > 1) {
    return m_decoder->etSmall(m_roiWord);
  } else {
    float highest = 0;
    std::map<unsigned int, unsigned int>::const_iterator it =
        m_triggerThresholdValue.begin();
    for (; it != m_triggerThresholdValue.end(); ++it)
      if (it->second > highest)
        highest = it->second;
    return highest;
  }
}

frame()

unsigned int LVL1::RecJetRoI::frame ( ) const

virtual

returns RoI frame number

returns frame number of ROI

Definition at line 265 of file RecJetRoI.cxx.

                           {
  unsigned int row = m_decoder->row(m_roiWord);
  unsigned int col = m_decoder->column(m_roiWord);
  return ((col & 2) << 1) + (row >> 1);
}

isForwardJet()

bool LVL1::RecJetRoI::isForwardJet

(

)

const

returns true if the RoI is a forward jet RoI.

A forward jet is defined as one that passes ANY forward jet threshold. For legacy compatibility with Run 1 only. Deprecated in Run 2

A forward jet is defined as one that passes ANY forward jet threshold. Always false in Run 2 + 3

Definition at line 413 of file RecJetRoI.cxx.

{
  if (m_version <= 1 && ((1 << 18) & m_roiWord))
    return true;
  return false;
}

isValidThreshold()

bool LVL1::RecJetRoI::isValidThreshold

(

unsigned int

thresh

)

const

returns true if thresh is a valid threshold number

Definition at line 400 of file RecJetRoI.cxx.

{
  if (!this->isForwardJet()) {
    return (thresh <= TrigT1CaloDefs::numOfJetThresholds);
  } else {
    return (thresh <= TrigT1CaloDefs::numOfFwdJetThresholds);
  }
}

localcoord()

unsigned int LVL1::RecJetRoI::localcoord ( ) const

virtual

returns local coordinate within frame

Definition at line 273 of file RecJetRoI.cxx.

                                {
  unsigned int row = m_decoder->row(m_roiWord);
  unsigned int col = m_decoder->column(m_roiWord);
  return (col & 1) + ((row & 1) << 1);
}

module()

unsigned int LVL1::RecJetRoI::module ( ) const

virtual

returns JEM number

returns module number of ROI

Definition at line 261 of file RecJetRoI.cxx.

{ return m_decoder->module(m_roiWord); }

operator=()

LVL1::RecJetRoI & LVL1::RecJetRoI::operator=

(

RecJetRoI const &

obj

)

Definition at line 65 of file RecJetRoI.cxx.

                                                {
   if(this != &rhs) {
      m_roiWord = rhs.m_roiWord;
      delete m_decoder;
      m_decoder = new JEPRoIDecoder();
      m_version = rhs.m_version;
      m_coordRange = rhs.m_coordRange;
      m_thresholdMask = rhs.m_thresholdMask;
      m_triggerThresholdValue = rhs.m_triggerThresholdValue;
      m_windowSize = rhs.m_windowSize;
   }
   return *this;
}

passedFwdThreshold()

bool LVL1::RecJetRoI::passedFwdThreshold

(

unsigned int

thresholdNumber

)

const

Same for forward jets.

returns TRUE if threshold number threshold_number has been pass ed by this ROI.

Deprecated in Run 2, will always return false.

Returns FALSE if used in Run 2, where forward jet is not defined

Definition at line 336 of file RecJetRoI.cxx.

                                                                    {
 
  if ((m_version < 2) && this->isValidThreshold(thresholdNumber)) {
    return (((1 << (thresholdNumber + 7)) & m_roiWord) > 0);
  }
  return false;
}

passedThreshold()

bool LVL1::RecJetRoI::passedThreshold

(

unsigned int

thresholdNumber

)

const

returns TRUE if threshold number threshold_number has been passed by this ROI.

returns TRUE if threshold number threshold_number has been pass ed by this ROI.

Definition at line 320 of file RecJetRoI.cxx.

                                                                 {
 
  bool value = false;
 
  std::map<unsigned int, unsigned int>::const_iterator it =
      m_triggerThresholdValue.find(thresholdNumber);
  if (it != m_triggerThresholdValue.end())
    value = true;
 
  return value;
}

phi()

double LVL1::RecJetRoI::phi ( ) const

virtual

returns phi coord of ROI

Implements iRecCoordRoI.

Definition at line 243 of file RecJetRoI.cxx.

{
  double roiPhi = m_coordRange.phi();
  if (roiPhi > M_PI)
    roiPhi -= 2 * M_PI;
  return roiPhi;
}

roiWord()

unsigned int LVL1::RecJetRoI::roiWord ( ) const

virtual

returns roi word

Implements iRecCoordRoI.

Definition at line 239 of file RecJetRoI.cxx.

{ return m_roiWord; }

thresholdPattern()

unsigned int LVL1::RecJetRoI::thresholdPattern

(

)

const

returns bitmask of passed thresholds

returns mask of thresholds passed

Definition at line 315 of file RecJetRoI.cxx.

{ return m_thresholdMask; }

thresholdsPassed()

std::vector< unsigned int > LVL1::RecJetRoI::thresholdsPassed

(

)

const

returns a vector of thresholds passed.

Definition at line 352 of file RecJetRoI.cxx.

                                      {
 
  std::vector<unsigned int> newVec;// = new std::vector<unsigned int>;
 
  unsigned int nThresh = TrigT1CaloDefs::numOfJetCMXThresholds;
  if (m_version == 1) {
    if (this->isForwardJet())
      nThresh = TrigT1CaloDefs::numOfFwdJetThresholds;
    else
      nThresh = TrigT1CaloDefs::numOfJetThresholds;
  }
 
  for (unsigned int iTh = 0; iTh <= nThresh; ++iTh) {
    std::map<unsigned int, unsigned int>::const_iterator it =
        m_triggerThresholdValue.find(iTh);
    if (it != m_triggerThresholdValue.end())
      newVec.push_back(iTh);
  }
 
  return newVec;
}

triggerThreshold()

unsigned int LVL1::RecJetRoI::triggerThreshold

(

unsigned int

thresh

)

const

returns the value of the trigger threshold for the threshold passed.

Thresholds can vary by coordinate. Return value which matches coord of RecRoI

The trigger threshold is also sometimes called the cluster threshold.

Definition at line 379 of file RecJetRoI.cxx.

                                                               {
  map<unsigned int, unsigned int>::const_iterator it =
      m_triggerThresholdValue.find(thresh);
  if (it != m_triggerThresholdValue.end()) {
    return it->second;
  }
  return TrigT1CaloDefs::Error;
}

windowSize()

unsigned int LVL1::RecJetRoI::windowSize

(

unsigned int

thresh

)

const

returns the size of the window.

returns the value of the jet cluster for the threshold passed.

For Run 1 this should be 4, 6 or 8, for 4x4, 6x6, 8x8 jets. For Run 2 this should be 0 or 1, denoting large or small

Definition at line 390 of file RecJetRoI.cxx.

                                                         {
  map<unsigned int, unsigned int>::const_iterator it = m_windowSize.find(thresh);
  if (it != m_windowSize.end()) {
    return it->second;
  }
  return TrigT1CaloDefs::Error;
}

Member Data Documentation

m_coordRange

CoordinateRange LVL1::RecJetRoI::m_coordRange

private

this contains the coordinate range worked out from the RoIWord hardware coord (i.e.

crate number, CPM number etc.)

Definition at line 142 of file RecJetRoI.h.

m_decoder

JEPRoIDecoder* LVL1::RecJetRoI::m_decoder { 0 }

private

Used for decoding RoI word.

Definition at line 134 of file RecJetRoI.h.

m_roiWord

unsigned long int LVL1::RecJetRoI::m_roiWord { 0 }

private

this is the actual format of the data sent from the LVL1 hardware.

Definition at line 131 of file RecJetRoI.h.

m_thresholdMask

unsigned long int LVL1::RecJetRoI::m_thresholdMask { 0 }

private

Information on trigger thresholds passed by RoI.

Definition at line 145 of file RecJetRoI.h.

m_triggerThresholdValue

std::map< unsigned int, unsigned int > LVL1::RecJetRoI::m_triggerThresholdValue

private

Definition at line 147 of file RecJetRoI.h.

m_version

int LVL1::RecJetRoI::m_version { 0 }

private

Store the RoI format version.

Definition at line 137 of file RecJetRoI.h.

m_windowSize

std::map< unsigned int, unsigned int > LVL1::RecJetRoI::m_windowSize

private

Definition at line 148 of file RecJetRoI.h.

---

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

• RecJetRoI.h
• RecJetRoI.cxx