L1GtCaloCondition Class Reference

#include <L1GtCaloCondition.h>

Inheritance diagram for L1GtCaloCondition:

Public Member Functions
const bool	evaluateCondition () const override
	the core function to check if the condition matches More...
const L1GtCaloTemplate *	gtCaloTemplate () const
	get / set the pointer to a L1GtCondition More...
const int	gtCorrParDeltaPhiNrBins () const
	get / set maximum number of bins for the delta phi scales More...
const int	gtIfCaloEtaNumberBits () const
	get / set the number of bits for eta of calorimeter objects More...
const L1GlobalTriggerPSB *	gtPSB () const
	get / set the pointer to PSB More...
	L1GtCaloCondition ()
	L1GtCaloCondition (const L1GtCondition *, const L1GlobalTriggerPSB *, const int nrL1NoIsoEG, const int nrL1IsoEG, const int nrL1CenJet, const int nrL1ForJet, const int nrL1TauJet, const int ifCaloEtaNumberBits)
	from base template condition (from event setup usually) More...
	L1GtCaloCondition (const L1GtCaloCondition &)
L1GtCaloCondition &	operator= (const L1GtCaloCondition &)
void	print (std::ostream &myCout) const override
	print condition More...
void	setGtCaloTemplate (const L1GtCaloTemplate *)
void	setGtCorrParDeltaPhiNrBins (const int &)
void	setGtIfCaloEtaNumberBits (const int &)
void	setGtPSB (const L1GlobalTriggerPSB *)
	set the pointer to PSB More...
	~L1GtCaloCondition () override
Public Member Functions inherited from L1GtConditionEvaluation
bool	condLastResult () const
	get the latest result for the condition More...
int	condMaxNumberObjects () const
void	evaluateConditionStoreResult ()
	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...
	L1GtConditionEvaluation ()
	constructor More...
void	setCondMaxNumberObjects (int condMaxNumberObjectsValue)
void	setVerbosity (const int verbosity)
virtual	~L1GtConditionEvaluation ()
	destructor More...

Private Member Functions
const bool	checkObjectParameter (const int iCondition, const L1GctCand &cand) const
	function to check a single object if it matches a condition More...
void	copy (const L1GtCaloCondition &cp)
	copy function for copy constructor and operator= More...
const L1GctCand *	getCandidate (const int indexCand) const
	load calo candidates More...

Private Attributes
unsigned int	m_corrParDeltaPhiNrBins
const L1GtCaloTemplate *	m_gtCaloTemplate
	pointer to a L1GtCaloTemplate More...
const L1GlobalTriggerPSB *	m_gtPSB
	pointer to PSB, to be able to get the trigger objects More...
int	m_ifCaloEtaNumberBits
	number of bits for eta of calorimeter objects More...

Additional Inherited Members
Protected Member Functions inherited from L1GtConditionEvaluation
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 , class Type2 >
const bool	checkThreshold (const Type1 &threshold, const Type2 &value, const bool condGEqValue) const
CombinationsInCond &	combinationsInCond () const
	get all the object combinations (to fill it...) More...
Protected Attributes inherited from L1GtConditionEvaluation
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

Description: evaluation of a CondCalo condition.

Implementation: <TODO: enter implementation details>

Author

: Vasile Mihai Ghete - HEPHY Vienna

Definition at line 35 of file L1GtCaloCondition.h.

Constructor & Destructor Documentation

L1GtCaloCondition() [1/3]

L1GtCaloCondition::L1GtCaloCondition

(

)

constructors default

Definition at line 48 of file L1GtCaloCondition.cc.

References m_corrParDeltaPhiNrBins, and m_ifCaloEtaNumberBits.

                                     : L1GtConditionEvaluation() {
  m_ifCaloEtaNumberBits = -1;
  m_corrParDeltaPhiNrBins = 0;
}

L1GtCaloCondition() [2/3]

L1GtCaloCondition::L1GtCaloCondition	(	const L1GtCondition *	caloTemplate,
		const L1GlobalTriggerPSB *	ptrPSB,
		const int	nrL1NoIsoEG,
		const int	nrL1IsoEG,
		const int	nrL1CenJet,
		const int	nrL1ForJet,
		const int	nrL1TauJet,
		const int	ifCaloEtaNumberBits
	)

from base template condition (from event setup usually)

Definition at line 54 of file L1GtCaloCondition.cc.

References CenJet, ForJet, IsoEG, L1GtConditionEvaluation::m_condMaxNumberObjects, m_corrParDeltaPhiNrBins, m_gtCaloTemplate, NoIsoEG, L1GtCondition::objectType(), and TauJet.

    : L1GtConditionEvaluation(),
      m_gtCaloTemplate(static_cast<const L1GtCaloTemplate *>(caloTemplate)),
      m_gtPSB(ptrPSB),
      m_ifCaloEtaNumberBits(ifCaloEtaNumberBits) {
  m_corrParDeltaPhiNrBins = 0;

  // maximum number of objects received for the evaluation of the condition
  // retrieved before from event setup
  // for a CondCalo, all objects ar of same type, hence it is enough to get the
  // type for the first object

  switch ((m_gtCaloTemplate->objectType())[0]) {
    case NoIsoEG:
      m_condMaxNumberObjects = nrL1NoIsoEG;
      break;
    case IsoEG:
      m_condMaxNumberObjects = nrL1IsoEG;
      break;
    case CenJet:
      m_condMaxNumberObjects = nrL1CenJet;
      break;
    case ForJet:
      m_condMaxNumberObjects = nrL1ForJet;
      break;
    case TauJet:
      m_condMaxNumberObjects = nrL1TauJet;
      break;
    default:
      m_condMaxNumberObjects = 0;
      break;
  }
}

L1GtCaloCondition() [3/3]

L1GtCaloCondition::L1GtCaloCondition

(

const L1GtCaloCondition &

cp

)

Definition at line 110 of file L1GtCaloCondition.cc.

References copy().

: L1GtConditionEvaluation() { copy(cp); }

~L1GtCaloCondition()

L1GtCaloCondition::~L1GtCaloCondition ( )

override

Definition at line 113 of file L1GtCaloCondition.cc.

                                      {
  // empty
}

Member Function Documentation

checkObjectParameter()

const bool L1GtCaloCondition::checkObjectParameter ( const int  iCondition, const L1GctCand &  cand  ) const

private

function to check a single object if it matches a condition

checkObjectParameter - Compare a single particle with a numbered condition.

Parameters

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

Returns

The result of the comparison (false if a condition does not exist).

Definition at line 367 of file L1GtCaloCondition.cc.

References L1GtConditionEvaluation::checkBit(), L1GtConditionEvaluation::checkThreshold(), L1GtCondition::condGEq(), L1GtCaloTemplate::ObjectParameter::etaRange, L1GtCaloTemplate::ObjectParameter::etThreshold, m_gtCaloTemplate, L1GtCondition::nrObjects(), L1GtCaloTemplate::objectParameter(), and L1GtCaloTemplate::ObjectParameter::phiRange.

Referenced by evaluateCondition().

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

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

  // empty candidates can not be compared
  if (cand.empty()) {
    return false;
  }

  const L1GtCaloTemplate::ObjectParameter objPar = (*(m_gtCaloTemplate->objectParameter()))[iCondition];

  // check energy threshold
  if (!checkThreshold(objPar.etThreshold, cand.rank(), m_gtCaloTemplate->condGEq())) {
    return false;
  }

  // check eta
  if (!checkBit(objPar.etaRange, cand.etaIndex())) {
    return false;
  }

  // check phi

  if (!checkBit(objPar.phiRange, cand.phiIndex())) {
    return false;
  }

  // particle matches if we get here
  // LogTrace("L1GlobalTrigger")
  //    << "  checkObjectParameter: calorimeter object OK, passes all
  //    requirements\n"
  //    << std::endl;

  return true;
}

copy()

void L1GtCaloCondition::copy ( const L1GtCaloCondition &  cp )

private

copy function for copy constructor and operator=

Definition at line 96 of file L1GtCaloCondition.cc.

References L1GtConditionEvaluation::m_combinationsInCond, L1GtConditionEvaluation::m_condLastResult, L1GtConditionEvaluation::m_condMaxNumberObjects, m_corrParDeltaPhiNrBins, m_gtCaloTemplate, m_gtPSB, m_ifCaloEtaNumberBits, and L1GtConditionEvaluation::m_verbosity.

Referenced by L1GtCaloCondition(), and operator=().

                                                        {
  m_gtCaloTemplate = cp.gtCaloTemplate();
  m_gtPSB = cp.gtPSB();

  m_ifCaloEtaNumberBits = cp.gtIfCaloEtaNumberBits();
  m_corrParDeltaPhiNrBins = cp.m_corrParDeltaPhiNrBins;

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

  m_verbosity = cp.m_verbosity;
}

evaluateCondition()

const bool L1GtCaloCondition::evaluateCondition ( ) const

overridevirtual

the core function to check if the condition matches

Implements L1GtConditionEvaluation.

Definition at line 140 of file L1GtCaloCondition.cc.

References funct::abs(), CenJet, L1GtConditionEvaluation::checkBit(), checkObjectParameter(), L1GtConditionEvaluation::combinationsInCond(), L1GtCaloTemplate::correlationParameter(), L1GtCaloTemplate::CorrelationParameter::deltaEtaRange, L1GtCaloTemplate::CorrelationParameter::deltaPhiRange, factorial(), ForJet, L1GlobalTriggerPSB::getCandL1CenJet(), L1GlobalTriggerPSB::getCandL1ForJet(), L1GlobalTriggerPSB::getCandL1IsoEG(), L1GlobalTriggerPSB::getCandL1NoIsoEG(), L1GlobalTriggerPSB::getCandL1TauJet(), mps_fire::i, IsoEG, LogTrace, m_corrParDeltaPhiNrBins, m_gtCaloTemplate, m_gtPSB, m_ifCaloEtaNumberBits, L1GtConditionEvaluation::m_verbosity, NoIsoEG, L1GtCondition::nrObjects(), L1GtCondition::objectType(), TauJet, and L1GtCondition::wsc().

                                                      {
  // number of trigger objects in the condition
  int nObjInCond = m_gtCaloTemplate->nrObjects();
  // LogTrace("L1GlobalTrigger") << "  nObjInCond: " << nObjInCond
  //    << std::endl;

  // the candidates

  // objectType() gives the type for nrObjects() only,
  // but in a CondCalo all objects have the same type
  // take type from the type of the first object

  const std::vector<const L1GctCand *> *candVec;

  switch ((m_gtCaloTemplate->objectType())[0]) {
    case NoIsoEG:
      candVec = m_gtPSB->getCandL1NoIsoEG();
      break;
    case IsoEG:
      candVec = m_gtPSB->getCandL1IsoEG();
      break;
    case CenJet:
      candVec = m_gtPSB->getCandL1CenJet();
      break;
    case ForJet:
      candVec = m_gtPSB->getCandL1ForJet();
      break;
    case TauJet:
      candVec = m_gtPSB->getCandL1TauJet();
      break;
    default:
      return false;
      break;
  }

  int numberObjects = candVec->size();
  // LogTrace("L1GlobalTrigger") << "  numberObjects: " << numberObjects
  //    << std::endl;
  if (numberObjects < nObjInCond) {
    return false;
  }

  std::vector<int> index(numberObjects);

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

  int jumpIndex = 1;
  int jump = factorial(numberObjects - nObjInCond);

  // condition result condResult set to true if at least one permutation
  //     passes all requirements
  // all possible permutations are checked
  bool condResult = false;

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

  // clear the m_combinationsInCond vector
  combinationsInCond().clear();

  do {
    if (--jumpIndex)
      continue;

    jumpIndex = jump;

    // clear the indices in the combination
    objectsInComb.clear();

    bool tmpResult = true;

    // check if there is a permutation that matches object-parameter
    // requirements
    for (int i = 0; i < nObjInCond; i++) {
      tmpResult &= checkObjectParameter(i, *(*candVec)[index[i]]);
      objectsInComb.push_back(index[i]);
    }

    // if permutation does not match particle conditions
    // skip spatial correlations
    if (!tmpResult) {
      continue;
    }

    if (m_gtCaloTemplate->wsc()) {
      // wsc requirements have always nObjInCond = 2
      // one can use directly index[0] and index[1] to compute
      // eta and phi differences
      const int ObjInWscComb = 2;
      if (nObjInCond != ObjInWscComb) {
        if (m_verbosity) {
          edm::LogError("L1GlobalTrigger")
              << "\n  Error: "
              << "number of particles in condition with spatial correlation = " << nObjInCond
              << "\n  it must be = " << ObjInWscComb << std::endl;
        }

        continue;
      }

      L1GtCaloTemplate::CorrelationParameter corrPar = *(m_gtCaloTemplate->correlationParameter());

      unsigned int candDeltaEta;
      unsigned int candDeltaPhi;

      // check candDeltaEta

      // get eta index and the sign bit of the eta index (MSB is the sign)
      //   signedEta[i] is the signed eta index of candVec[index[i]]
      int signedEta[ObjInWscComb];
      int signBit[ObjInWscComb] = {0, 0};

      int scaleEta = 1 << (m_ifCaloEtaNumberBits - 1);

      for (int i = 0; i < ObjInWscComb; ++i) {
        signBit[i] = ((*candVec)[index[i]]->etaIndex() & scaleEta) >> (m_ifCaloEtaNumberBits - 1);
        signedEta[i] = ((*candVec)[index[i]]->etaIndex()) % scaleEta;

        if (signBit[i] == 1) {
          signedEta[i] = (-1) * signedEta[i];
        }
      }

      // compute candDeltaEta - add 1 if signs are different (due to +0/-0
      // indices)
      candDeltaEta =
          static_cast<int>(std::abs(signedEta[1] - signedEta[0])) + static_cast<int>(signBit[1] ^ signBit[0]);

      if (!checkBit(corrPar.deltaEtaRange, candDeltaEta)) {
        continue;
      }

      // check candDeltaPhi

      // calculate absolute value of candDeltaPhi
      if ((*candVec)[index[0]]->phiIndex() > (*candVec)[index[1]]->phiIndex()) {
        candDeltaPhi = (*candVec)[index[0]]->phiIndex() - (*candVec)[index[1]]->phiIndex();
      } else {
        candDeltaPhi = (*candVec)[index[1]]->phiIndex() - (*candVec)[index[0]]->phiIndex();
      }

      // check if candDeltaPhi > 180 (via delta_phi_maxbits)
      // delta_phi contains bits for 0..180 (0 and 180 included)
      // protect also against infinite loop...

      int nMaxLoop = 10;
      int iLoop = 0;

      while (candDeltaPhi >= m_corrParDeltaPhiNrBins) {
        unsigned int candDeltaPhiInitial = candDeltaPhi;

        // candDeltaPhi > 180 ==> take 360 - candDeltaPhi
        candDeltaPhi = (m_corrParDeltaPhiNrBins - 1) * 2 - candDeltaPhi;
        if (m_verbosity) {
          LogTrace("L1GlobalTrigger") << "    Initial candDeltaPhi = " << candDeltaPhiInitial
                                      << " > m_corrParDeltaPhiNrBins = " << m_corrParDeltaPhiNrBins
                                      << "  ==> candDeltaPhi rescaled to: " << candDeltaPhi << " [ loop index " << iLoop
                                      << "; breaks after " << nMaxLoop << " loops ]\n"
                                      << std::endl;
        }

        iLoop++;
        if (iLoop > nMaxLoop) {
          return false;
        }
      }

      if (!checkBit(corrPar.deltaPhiRange, candDeltaPhi)) {
        continue;
      }

    }  // end wsc check

    // if we get here all checks were successful for this combination
    // set the general result for evaluateCondition to "true"

    condResult = true;
    combinationsInCond().push_back(objectsInComb);

    //    } while ( std::next_permutation(index, index + nObj) );
  } while (std::next_permutation(index.begin(), index.end()));

  return condResult;
}

getCandidate()

const L1GctCand * L1GtCaloCondition::getCandidate ( const int  indexCand ) const

private

load calo candidates

Definition at line 330 of file L1GtCaloCondition.cc.

References CenJet, ForJet, L1GlobalTriggerPSB::getCandL1CenJet(), L1GlobalTriggerPSB::getCandL1ForJet(), L1GlobalTriggerPSB::getCandL1IsoEG(), L1GlobalTriggerPSB::getCandL1NoIsoEG(), L1GlobalTriggerPSB::getCandL1TauJet(), IsoEG, m_gtCaloTemplate, m_gtPSB, NoIsoEG, L1GtCondition::objectType(), and TauJet.

                                                                          {
  // objectType() gives the type for nrObjects() only,
  // but in a CondCalo all objects have the same type
  // take type from the type of the first object
  switch ((m_gtCaloTemplate->objectType())[0]) {
    case NoIsoEG:
      return (*(m_gtPSB->getCandL1NoIsoEG()))[indexCand];
      break;
    case IsoEG:
      return (*(m_gtPSB->getCandL1IsoEG()))[indexCand];
      break;
    case CenJet:
      return (*(m_gtPSB->getCandL1CenJet()))[indexCand];
      break;
    case ForJet:
      return (*(m_gtPSB->getCandL1ForJet()))[indexCand];
      break;
    case TauJet:
      return (*(m_gtPSB->getCandL1TauJet()))[indexCand];
      break;
    default:
      return nullptr;
      break;
  }

  return nullptr;
}

gtCaloTemplate()

const L1GtCaloTemplate* L1GtCaloCondition::gtCaloTemplate ( ) const

inline

get / set the pointer to a L1GtCondition

Definition at line 69 of file L1GtCaloCondition.h.

References m_gtCaloTemplate.

{ return m_gtCaloTemplate; }

gtCorrParDeltaPhiNrBins()

const int L1GtCaloCondition::gtCorrParDeltaPhiNrBins ( ) const

inline

get / set maximum number of bins for the delta phi scales

Definition at line 84 of file L1GtCaloCondition.h.

References m_corrParDeltaPhiNrBins.

{ return m_corrParDeltaPhiNrBins; }

gtIfCaloEtaNumberBits()

const int L1GtCaloCondition::gtIfCaloEtaNumberBits ( ) const

inline

get / set the number of bits for eta of calorimeter objects

Definition at line 79 of file L1GtCaloCondition.h.

References m_ifCaloEtaNumberBits.

{ return m_ifCaloEtaNumberBits; }

gtPSB()

const L1GlobalTriggerPSB* L1GtCaloCondition::gtPSB ( ) const

inline

get / set the pointer to PSB

Definition at line 74 of file L1GtCaloCondition.h.

References m_gtPSB.

{ return m_gtPSB; }

operator=()

L1GtCaloCondition & L1GtCaloCondition::operator=

(

const L1GtCaloCondition &

cp

)

Definition at line 118 of file L1GtCaloCondition.cc.

References copy().

                                                                           {
  copy(cp);
  return *this;
}

print()

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

overridevirtual

print condition

Reimplemented from L1GtConditionEvaluation.

Definition at line 407 of file L1GtCaloCondition.cc.

References m_corrParDeltaPhiNrBins, m_gtCaloTemplate, m_ifCaloEtaNumberBits, L1GtConditionEvaluation::print(), and L1GtCaloTemplate::print().

Referenced by L1GtCorrelationCondition::evaluateCondition(), and L1GlobalTriggerGTL::run().

                                                      {
  m_gtCaloTemplate->print(myCout);

  myCout << "    Number of bits for eta of calorimeter objects = " << m_ifCaloEtaNumberBits << std::endl;
  myCout << "    Maximum number of bins for the delta phi scales = " << m_corrParDeltaPhiNrBins << "\n " << std::endl;

  L1GtConditionEvaluation::print(myCout);
}

setGtCaloTemplate()

void L1GtCaloCondition::setGtCaloTemplate

(

const L1GtCaloTemplate *

caloTempl

)

Definition at line 124 of file L1GtCaloCondition.cc.

References m_gtCaloTemplate.

{ m_gtCaloTemplate = caloTempl; }

setGtCorrParDeltaPhiNrBins()

void L1GtCaloCondition::setGtCorrParDeltaPhiNrBins

(

const int &

corrParDeltaPhiNrBins

)

Definition at line 135 of file L1GtCaloCondition.cc.

References m_corrParDeltaPhiNrBins.

Referenced by L1GlobalTriggerGTL::run().

                                                                                   {
  m_corrParDeltaPhiNrBins = corrParDeltaPhiNrBins;
}

setGtIfCaloEtaNumberBits()

void L1GtCaloCondition::setGtIfCaloEtaNumberBits

(

const int &

ifCaloEtaNumberBitsValue

)

Definition at line 130 of file L1GtCaloCondition.cc.

References m_ifCaloEtaNumberBits.

                                                                                    {
  m_ifCaloEtaNumberBits = ifCaloEtaNumberBitsValue;
}

setGtPSB()

void L1GtCaloCondition::setGtPSB

(

const L1GlobalTriggerPSB *

ptrPSB

)

set the pointer to PSB

Definition at line 127 of file L1GtCaloCondition.cc.

References m_gtPSB.

{ m_gtPSB = ptrPSB; }

Member Data Documentation

m_corrParDeltaPhiNrBins

unsigned int L1GtCaloCondition::m_corrParDeltaPhiNrBins

private

Definition at line 109 of file L1GtCaloCondition.h.

Referenced by copy(), evaluateCondition(), gtCorrParDeltaPhiNrBins(), L1GtCaloCondition(), print(), and setGtCorrParDeltaPhiNrBins().

m_gtCaloTemplate

const L1GtCaloTemplate* L1GtCaloCondition::m_gtCaloTemplate

private

pointer to a L1GtCaloTemplate

Definition at line 100 of file L1GtCaloCondition.h.

Referenced by checkObjectParameter(), copy(), evaluateCondition(), getCandidate(), gtCaloTemplate(), L1GtCaloCondition(), print(), and setGtCaloTemplate().

m_gtPSB

const L1GlobalTriggerPSB* L1GtCaloCondition::m_gtPSB

private

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

Definition at line 103 of file L1GtCaloCondition.h.

Referenced by copy(), evaluateCondition(), getCandidate(), gtPSB(), and setGtPSB().

m_ifCaloEtaNumberBits

int L1GtCaloCondition::m_ifCaloEtaNumberBits

private

number of bits for eta of calorimeter objects

Definition at line 106 of file L1GtCaloCondition.h.

Referenced by copy(), evaluateCondition(), gtIfCaloEtaNumberBits(), L1GtCaloCondition(), print(), and setGtIfCaloEtaNumberBits().