l1t::MuonShowerCondition Class Reference

#include <MuonShowerCondition.h>

Inheritance diagram for l1t::MuonShowerCondition:

Public Member Functions
const bool	evaluateCondition (const int bxEval) const override
	the core function to check if the condition matches More...
const GlobalBoard *	gtGTL () const
	get / set the pointer to GTL More...
const MuonShowerTemplate *	gtMuonShowerTemplate () const
	get / set the pointer to a Condition More...
	MuonShowerCondition ()
	MuonShowerCondition (const GlobalCondition *, const GlobalBoard *, const int nrL1MuShower)
	from base template condition (from event setup usually) More...
	MuonShowerCondition (const MuonShowerCondition &)
MuonShowerCondition &	operator= (const MuonShowerCondition &)
void	print (std::ostream &myCout) const override
	print condition More...
void	setGtGTL (const GlobalBoard *)
	Set the pointer to GTL. More...
void	setGtMuonShowerTemplate (const MuonShowerTemplate *)
	~MuonShowerCondition () override
Public Member Functions inherited from l1t::ConditionEvaluation
	ConditionEvaluation ()
	constructor More...
bool	condLastResult () const
	get the latest result for the condition More...
int	condMaxNumberObjects () const
void	evaluateConditionStoreResult (const int bxEval)
	call evaluateCondition and save last result More...
CombinationsInCond const &	getCombinationsInCond () const
	get all the object combinations evaluated to true in the condition More...
virtual std::string	getNumericExpression () const
	get numeric expression More...
void	setCondMaxNumberObjects (int condMaxNumberObjectsValue)
void	setVerbosity (const int verbosity)
virtual	~ConditionEvaluation ()
	destructor More...

Private Member Functions
const bool	checkObjectParameter (const int iCondition, const l1t::MuonShower &cand, const unsigned int index) const
	function to check a single object if it matches a condition More...
void	copy (const MuonShowerCondition &cp)
	copy function for copy constructor and operator= More...
const l1t::MuonShower *	getCandidate (const int bx, const int indexCand) const
	load muon candidates More...

Private Attributes
const GlobalBoard *	m_gtGTL
	pointer to GTL, to be able to get the trigger objects More...
const MuonShowerTemplate *	m_gtMuonShowerTemplate
	pointer to a MuonShowerTemplate More...

Additional Inherited Members
Protected Member Functions inherited from l1t::ConditionEvaluation
template<class Type1 >
const bool	checkBit (const Type1 &mask, const unsigned int bitNumber) const
	check if a bit with a given number is set in a mask More...
template<class Type1 >
const bool	checkIndex (const Type1 &indexLo, const Type1 &indexHi, const unsigned int index) const
	check if a index is in a given range More...
template<class Type1 >
const bool	checkRangeDeltaEta (const unsigned int obj1Eta, const unsigned int obj2Eta, const Type1 &lowerR, const Type1 &upperR, const unsigned int nEtaBits) const
	check if a value is in a given range More...
template<class Type1 >
const bool	checkRangeDeltaPhi (const unsigned int obj1Phi, const unsigned int obj2Phi, const Type1 &lowerR, const Type1 &upperR) const
	check if a value is in a given range More...
template<class Type1 >
const bool	checkRangeEta (const unsigned int bitNumber, const Type1 &W1beginR, const Type1 &W1endR, const Type1 &W2beginR, const Type1 &W2endR, const unsigned int nEtaBits) const
	check if a value is in a given range and outside of a veto range More...
template<class Type1 >
const bool	checkRangePhi (const unsigned int bitNumber, const Type1 &W1beginR, const Type1 &W1endR, const Type1 &W2beginR, const Type1 &W2endR) const
	check if a value is in a given range and outside of a veto range More...
template<class Type1 , class Type2 >
const bool	checkThreshold (const Type1 &thresholdL, const Type1 &thresholdH, const Type2 &value, bool condGEqValue) const
template<class Type1 , class Type2 >
const bool	checkUnconstrainedPt (const Type1 &thresholdL, const Type1 &thresholdH, const Type2 &value, bool condGEqValue) const
CombinationsInCond &	combinationsInCond () const
	get all the object combinations (to fill it...) More...
Protected Attributes inherited from l1t::ConditionEvaluation
CombinationsInCond	m_combinationsInCond
	store all the object combinations evaluated to true in the condition More...
bool	m_condLastResult
	the last result of evaluateCondition() More...
int	m_condMaxNumberObjects
int	m_verbosity
	verbosity level More...

Detailed Description

Definition at line 29 of file MuonShowerCondition.h.

Constructor & Destructor Documentation

MuonShowerCondition() [1/3]

MuonShowerCondition::MuonShowerCondition

(

)

constructors default

Definition at line 43 of file MuonShowerCondition.cc.

                                            : ConditionEvaluation() {
  // empty
}

MuonShowerCondition() [2/3]

MuonShowerCondition::MuonShowerCondition	(	const GlobalCondition *	muonShowerTemplate,
		const GlobalBoard *	ptrGTL,
		const int	nrL1MuShower
	)

from base template condition (from event setup usually)

Definition at line 48 of file MuonShowerCondition.cc.

References l1t::ConditionEvaluation::m_condMaxNumberObjects.

    : ConditionEvaluation(),
      m_gtMuonShowerTemplate(static_cast<const MuonShowerTemplate*>(muonShowerTemplate)),
      m_gtGTL(ptrGTL) {
  m_condMaxNumberObjects = nrL1MuShower;
}

MuonShowerCondition() [3/3]

MuonShowerCondition::MuonShowerCondition

(

const MuonShowerCondition &

cp

)

Definition at line 69 of file MuonShowerCondition.cc.

References copy().

: ConditionEvaluation() { copy(cp); }

~MuonShowerCondition()

MuonShowerCondition::~MuonShowerCondition ( )

override

Definition at line 72 of file MuonShowerCondition.cc.

                                             {
  // empty
}

Member Function Documentation

checkObjectParameter()

const bool MuonShowerCondition::checkObjectParameter ( const int  iCondition, const l1t::MuonShower &  cand, const unsigned int  index  ) const

private

function to check a single object if it matches a condition

checkObjectParameter - Check if the bit associated to the type of shower is set to 1

Parameters

iCondition	The number of the condition.
cand	The candidate to compare.

Returns

The result of the check on the condition (false if a condition does not exist)

Definition at line 166 of file MuonShowerCondition.cc.

References LogDebug, MuonShowerTemplate::ObjectParameter::MuonShower0, MuonShowerTemplate::ObjectParameter::MuonShower1, MuonShowerTemplate::ObjectParameter::MuonShowerOutOfTime0, and MuonShowerTemplate::ObjectParameter::MuonShowerOutOfTime1.

                                                                                          {
  // number of objects in condition
  int nObjInCond = m_gtMuonShowerTemplate->nrObjects();

  if (iCondition >= nObjInCond || iCondition < 0) {
    return false;
  }

  const MuonShowerTemplate::ObjectParameter objPar = (*(m_gtMuonShowerTemplate->objectParameter()))[iCondition];

  LogDebug("L1TGlobal") << "\n MuonShowerTemplate::ObjectParameter (utm objects, checking which condition is parsed): "
                        << std::hex << "\n\t MuonShower0 = 0x " << objPar.MuonShower0 << "\n\t MuonShower1 = 0x "
                        << objPar.MuonShower1 << "\n\t MuonShowerOutOfTime0 = 0x " << objPar.MuonShowerOutOfTime0
                        << "\n\t MuonShowerOutOfTime1 = 0x " << objPar.MuonShowerOutOfTime1 << std::endl;

  LogDebug("L1TGlobal") << "\n l1t::MuonShower (uGT emulator bits): "
                        << "\n\t MuonShower0: isOneNominalInTime() = " << cand.isOneNominalInTime()
                        << "\n\t MuonShower1: isOneTightInTime() = " << cand.isOneTightInTime()
                        << "\n\t MuonShowerOutOfTime0: musOutOfTime0() = " << cand.musOutOfTime0()
                        << "\n\t MuonShowerOutOfTime1: musOutOfTime1() = " << cand.musOutOfTime1() << std::endl;

  // Check oneNominalInTime
  if (cand.isOneNominalInTime() != objPar.MuonShower0) {
    LogDebug("L1TGlobal") << "\t\t MuonShower failed MuonShower0 requirement" << std::endl;
    return false;
  }
  // Check oneTightInTime
  if (cand.isOneTightInTime() != objPar.MuonShower1) {
    LogDebug("L1TGlobal") << "\t\t MuonShower failed MuonShower1 requirement" << std::endl;
    return false;
  }
  if (cand.musOutOfTime0() != objPar.MuonShowerOutOfTime0) {
    LogDebug("L1TGlobal") << "\t\t MuonShower failed MuonShowerOutOfTime0 requirement" << std::endl;
    return false;
  }
  if (cand.musOutOfTime1() != objPar.MuonShowerOutOfTime1) {
    LogDebug("L1TGlobal") << "\t\t MuonShower failed MuonShowerOutOfTime1 requirement" << std::endl;
    return false;
  }

  return true;
}

copy()

void MuonShowerCondition::copy ( const MuonShowerCondition &  cp )

private

copy function for copy constructor and operator=

Definition at line 58 of file MuonShowerCondition.cc.

Referenced by MuonShowerCondition().

                                                                  {
  m_gtMuonShowerTemplate = cp.gtMuonShowerTemplate();
  m_gtGTL = cp.gtGTL();

  m_condMaxNumberObjects = cp.condMaxNumberObjects();
  m_condLastResult = cp.condLastResult();
  m_combinationsInCond = cp.getCombinationsInCond();

  m_verbosity = cp.m_verbosity;
}

evaluateCondition()

const bool MuonShowerCondition::evaluateCondition ( const int  bxEval ) const

overridevirtual

the core function to check if the condition matches

Implements l1t::ConditionEvaluation.

Definition at line 91 of file MuonShowerCondition.cc.

References BXVector< T >::at(), BXVector< T >::getLastBX(), mps_fire::i, LogDebug, push_back(), and BXVector< T >::size().

                                                                           {
  bool condResult = false;

  /* Number of trigger objects in the condition:
  // it is always 1 because at the uGT there is only one shower object per BX (that can be of several types).
  // See DN2020_033_v4 (sections 7.5 and 7.6) for reference
  */
  int nObjInCond = m_gtMuonShowerTemplate->nrObjects();

  const BXVector<std::shared_ptr<l1t::MuonShower>>* candVec = m_gtGTL->getCandL1MuShower();

  // Look at objects in BX = BX + relativeBX
  int useBx = bxEval + m_gtMuonShowerTemplate->condRelativeBx();
  LogDebug("MuonShowerCondition") << "Considering BX " << useBx << std::endl;

  // Fail condition if attempting to get BX outside of range
  if ((useBx < candVec->getFirstBX()) || (useBx > candVec->getLastBX())) {
    return false;
  }

  // Store the indices of the shower objects from the combination evaluated in the condition
  SingleCombInCond objectsInComb;
  objectsInComb.reserve(nObjInCond);

  // Clear the m_combinationsInCond vector
  combinationsInCond().clear();
  // Clear the indices in the combination
  objectsInComb.clear();

  /* If no candidates, no need to check further.
  // If there is a muon shower trigger, the size of the candidates vector is always 4:
  // in fact, we have four muon shower objects created in the Global Board.
  */
  int numberObjects = candVec->size(useBx);
  if (numberObjects < 1) {
    return false;
  }

  std::vector<int> index(numberObjects);
  for (int i = 0; i < numberObjects; ++i) {
    index[i] = i;
  }

  // index is always zero, as they are global quantities (there is only one object)
  int indexObj = 0;

  bool passCondition = false;

  for (int i = 0; i < numberObjects; i++) {
    passCondition = checkObjectParameter(0, *(candVec->at(useBx, index[i])), index[i]);  //BLW Change for BXVector
    condResult |= passCondition;
    if (passCondition) {
      LogDebug("MuonShowerCondition")
          << "===> MuShowerCondition::evaluateCondition, PASS! This muon shower passed the condition." << std::endl;
      objectsInComb.push_back(indexObj);
    } else
      LogDebug("MuonShowerCondition")
          << "===> MuShowerCondition::evaluateCondition, FAIL! This muon shower failed the condition." << std::endl;
  }

  // if we get here all checks were successfull for this combination
  // set the general result for evaluateCondition to "true"
  (combinationsInCond()).push_back(objectsInComb);

  return condResult;
}

getCandidate()

const l1t::MuonShower* l1t::MuonShowerCondition::getCandidate ( const int  bx, const int  indexCand  ) const

private

load muon candidates

gtGTL()

const GlobalBoard* l1t::MuonShowerCondition::gtGTL ( ) const

inline

get / set the pointer to GTL

Definition at line 59 of file MuonShowerCondition.h.

References m_gtGTL.

{ return m_gtGTL; }

gtMuonShowerTemplate()

const MuonShowerTemplate* l1t::MuonShowerCondition::gtMuonShowerTemplate ( ) const

inline

get / set the pointer to a Condition

Definition at line 54 of file MuonShowerCondition.h.

References m_gtMuonShowerTemplate.

{ return m_gtMuonShowerTemplate; }

operator=()

l1t::MuonShowerCondition & MuonShowerCondition::operator=

(

const MuonShowerCondition &

cp

)

Definition at line 77 of file MuonShowerCondition.cc.

References filterCSVwithJSON::copy.

                                                                                          {
  copy(cp);
  return *this;
}

print()

void MuonShowerCondition::print ( std::ostream &  myCout ) const

overridevirtual

print condition

Reimplemented from l1t::ConditionEvaluation.

Definition at line 211 of file MuonShowerCondition.cc.

References l1t::ConditionEvaluation::print().

Referenced by l1t::GlobalBoard::runGTL().

                                                           {
  m_gtMuonShowerTemplate->print(myCout);
  ConditionEvaluation::print(myCout);
}

setGtGTL()

void MuonShowerCondition::setGtGTL

(

const GlobalBoard *

ptrGTL

)

Set the pointer to GTL.

Definition at line 88 of file MuonShowerCondition.cc.

{ m_gtGTL = ptrGTL; }

setGtMuonShowerTemplate()

void MuonShowerCondition::setGtMuonShowerTemplate

(

const MuonShowerTemplate *

muonTempl

)

Definition at line 83 of file MuonShowerCondition.cc.

                                                                                        {
  m_gtMuonShowerTemplate = muonTempl;
}

Member Data Documentation

m_gtGTL

const GlobalBoard* l1t::MuonShowerCondition::m_gtGTL

private

pointer to GTL, to be able to get the trigger objects

Definition at line 77 of file MuonShowerCondition.h.

Referenced by gtGTL().

m_gtMuonShowerTemplate

const MuonShowerTemplate* l1t::MuonShowerCondition::m_gtMuonShowerTemplate

private

pointer to a MuonShowerTemplate

Definition at line 74 of file MuonShowerCondition.h.

Referenced by gtMuonShowerTemplate().