l1t::EnergySumCondition Class Reference

#include <EnergySumCondition.h>

Inheritance diagram for l1t::EnergySumCondition:

Public Member Functions
	EnergySumCondition ()
	EnergySumCondition (const GlobalCondition *, const GlobalBoard *)
	from base template condition (from event setup usually) More...
	EnergySumCondition (const EnergySumCondition &)
const bool	evaluateCondition (const int bxEval) const override
	the core function to check if the condition matches More...
const GlobalBoard *	getuGtB () const
	get / set the pointer to uGt GlobalBoard More...
const EnergySumTemplate *	gtEnergySumTemplate () const
	get / set the pointer to a L1GtCondition More...
EnergySumCondition &	operator= (const EnergySumCondition &)
void	print (std::ostream &myCout) const override
	print condition More...
void	setGtEnergySumTemplate (const EnergySumTemplate *)
void	setuGtB (const GlobalBoard *)
	set the pointer to uGT GlobalBoard More...
	~EnergySumCondition () 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
void	copy (const EnergySumCondition &cp)
	copy function for copy constructor and operator= More...

Private Attributes
const EnergySumTemplate *	m_gtEnergySumTemplate
	pointer to a EnergySumTemplate More...
const GlobalBoard *	m_uGtB
	pointer to uGt GlobalBoard, to be able to get the trigger objects 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 37 of file EnergySumCondition.h.

Constructor & Destructor Documentation

EnergySumCondition() [1/3]

EnergySumCondition::EnergySumCondition

(

)

constructors default

Definition at line 36 of file EnergySumCondition.cc.

                                          : ConditionEvaluation() {
  //empty
}

EnergySumCondition() [2/3]

EnergySumCondition::EnergySumCondition	(	const GlobalCondition *	eSumTemplate,
		const GlobalBoard *	ptrGTB
	)

from base template condition (from event setup usually)

Definition at line 41 of file EnergySumCondition.cc.

References l1t::ConditionEvaluation::m_condMaxNumberObjects.

    : ConditionEvaluation(),
      m_gtEnergySumTemplate(static_cast<const EnergySumTemplate*>(eSumTemplate)),
      m_uGtB(ptrGTB)

{
  // maximum number of objects received for the evaluation of the condition
  // energy sums are global quantities - one object per event

  m_condMaxNumberObjects = 1;
}

EnergySumCondition() [3/3]

EnergySumCondition::EnergySumCondition

(

const EnergySumCondition &

cp

)

Definition at line 65 of file EnergySumCondition.cc.

References copy().

: ConditionEvaluation() { copy(cp); }

~EnergySumCondition()

EnergySumCondition::~EnergySumCondition ( )

override

Definition at line 68 of file EnergySumCondition.cc.

                                           {
  // empty
}

Member Function Documentation

copy()

void EnergySumCondition::copy ( const EnergySumCondition &  cp )

private

copy function for copy constructor and operator=

Definition at line 54 of file EnergySumCondition.cc.

Referenced by EnergySumCondition().

                                                                {
  m_gtEnergySumTemplate = cp.gtEnergySumTemplate();
  m_uGtB = cp.getuGtB();

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

  m_verbosity = cp.m_verbosity;
}

evaluateCondition()

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

overridevirtual

the core function to check if the condition matches

Implements l1t::ConditionEvaluation.

Definition at line 87 of file EnergySumCondition.cc.

References BXVector< T >::at(), clear(), EnergySumTemplate::ObjectParameter::etHighThreshold, EnergySumTemplate::ObjectParameter::etLowThreshold, BXVector< T >::getLastBX(), l1t::gtAsymmetryEt, l1t::gtAsymmetryEtHF, l1t::gtAsymmetryHt, l1t::gtAsymmetryHtHF, l1t::gtCentrality0, l1t::gtCentrality1, l1t::gtCentrality2, l1t::gtCentrality3, l1t::gtCentrality4, l1t::gtCentrality5, l1t::gtCentrality6, l1t::gtCentrality7, l1t::gtETM, l1t::gtETMHF, l1t::gtETT, l1t::gtETTem, l1t::gtHTM, l1t::gtHTT, l1t::gtMinBiasHFM0, l1t::gtMinBiasHFM1, l1t::gtMinBiasHFP0, l1t::gtMinBiasHFP1, l1t::gtTowerCount, L1Analysis::kAsymEt, L1Analysis::kAsymEtHF, L1Analysis::kAsymHt, L1Analysis::kAsymHtHF, L1Analysis::kCentrality, L1Analysis::kMinBiasHFM0, L1Analysis::kMinBiasHFM1, L1Analysis::kMinBiasHFP0, L1Analysis::kMinBiasHFP1, L1Analysis::kMissingEt, L1Analysis::kMissingEtHF, L1Analysis::kMissingHt, L1Analysis::kTotalEt, L1Analysis::kTotalEtEm, L1Analysis::kTotalHt, L1Analysis::kTowerCount, LogDebug, EnergySumTemplate::ObjectParameter::phiWindow1Lower, EnergySumTemplate::ObjectParameter::phiWindow1Upper, EnergySumTemplate::ObjectParameter::phiWindow2Lower, EnergySumTemplate::ObjectParameter::phiWindow2Upper, push_back(), and BXVector< T >::size().

                                                                          {
  // number of trigger objects in the condition
  // in fact, there is only one object
  int iCondition = 0;

  // condition result condResult set to true if the energy sum
  // passes all requirements
  bool condResult = false;

  // store the indices of the calorimeter objects
  // from the combination evaluated in the condition
  SingleCombInCond objectsInComb;

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

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

  const BXVector<const l1t::EtSum*>* candVec = m_uGtB->getCandL1EtSum();

  // Look at objects in bx = bx + relativeBx
  int useBx = bxEval + m_gtEnergySumTemplate->condRelativeBx();

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

  // If no candidates, no use looking any further.
  int numberObjects = candVec->size(useBx);
  if (numberObjects < 1) {
    return false;
  }

  l1t::EtSum::EtSumType type;
  bool MissingEnergy = false;
  int centbit = 0;
  switch ((m_gtEnergySumTemplate->objectType())[0]) {
    case gtETM:
      type = l1t::EtSum::EtSumType::kMissingEt;
      MissingEnergy = true;
      break;
    case gtETT:
      type = l1t::EtSum::EtSumType::kTotalEt;
      MissingEnergy = false;
      break;
    case gtETTem:
      type = l1t::EtSum::EtSumType::kTotalEtEm;
      MissingEnergy = false;
      break;
    case gtHTM:
      type = l1t::EtSum::EtSumType::kMissingHt;
      MissingEnergy = true;
      break;
    case gtHTT:
      type = l1t::EtSum::EtSumType::kTotalHt;
      MissingEnergy = false;
      break;
    case gtETMHF:
      type = l1t::EtSum::EtSumType::kMissingEtHF;
      MissingEnergy = true;
      break;
    case gtTowerCount:
      type = l1t::EtSum::EtSumType::kTowerCount;
      MissingEnergy = false;
      break;
    case gtMinBiasHFP0:
      type = l1t::EtSum::EtSumType::kMinBiasHFP0;
      MissingEnergy = false;
      break;
    case gtMinBiasHFM0:
      type = l1t::EtSum::EtSumType::kMinBiasHFM0;
      MissingEnergy = false;
      break;
    case gtMinBiasHFP1:
      type = l1t::EtSum::EtSumType::kMinBiasHFP1;
      MissingEnergy = false;
      break;
    case gtMinBiasHFM1:
      type = l1t::EtSum::EtSumType::kMinBiasHFM1;
      MissingEnergy = false;
      break;
    case gtAsymmetryEt:
      type = l1t::EtSum::EtSumType::kAsymEt;
      MissingEnergy = false;
      break;
    case gtAsymmetryHt:
      type = l1t::EtSum::EtSumType::kAsymHt;
      MissingEnergy = false;
      break;
    case gtAsymmetryEtHF:
      type = l1t::EtSum::EtSumType::kAsymEtHF;
      MissingEnergy = false;
      break;
    case gtAsymmetryHtHF:
      type = l1t::EtSum::EtSumType::kAsymHtHF;
      MissingEnergy = false;
      break;
    case gtCentrality0:
      centbit = 0;
      type = l1t::EtSum::EtSumType::kCentrality;
      MissingEnergy = false;
      break;
    case gtCentrality1:
      centbit = 1;
      type = l1t::EtSum::EtSumType::kCentrality;
      MissingEnergy = false;
      break;
    case gtCentrality2:
      centbit = 2;
      type = l1t::EtSum::EtSumType::kCentrality;
      MissingEnergy = false;
      break;
    case gtCentrality3:
      centbit = 3;
      type = l1t::EtSum::EtSumType::kCentrality;
      MissingEnergy = false;
      break;
    case gtCentrality4:
      centbit = 4;
      type = l1t::EtSum::EtSumType::kCentrality;
      MissingEnergy = false;
      break;
    case gtCentrality5:
      centbit = 5;
      type = l1t::EtSum::EtSumType::kCentrality;
      MissingEnergy = false;
      break;
    case gtCentrality6:
      centbit = 6;
      type = l1t::EtSum::EtSumType::kCentrality;
      MissingEnergy = false;
      break;
    case gtCentrality7:
      centbit = 7;
      type = l1t::EtSum::EtSumType::kCentrality;
      MissingEnergy = false;
      break;
    default:
      edm::LogError("L1TGlobal")
          << "\n  Error: "
          << "Unmatched object type from template to EtSumType, (m_gtEnergySumTemplate->objectType())[0] = "
          << (m_gtEnergySumTemplate->objectType())[0] << std::endl;
      type = l1t::EtSum::EtSumType::kTotalEt;
      break;
  }

  // get energy, phi (ETM and HTM) and overflow for the trigger object
  unsigned int candEt = 0;
  unsigned int candPhi = 0;
  bool candOverflow = false;
  for (int iEtSum = 0; iEtSum < numberObjects; ++iEtSum) {
    l1t::EtSum cand = *(candVec->at(useBx, iEtSum));
    if (cand.getType() != type)
      continue;
    candEt = cand.hwPt();
    candPhi = cand.hwPhi();
  }

  const EnergySumTemplate::ObjectParameter objPar = (*(m_gtEnergySumTemplate->objectParameter()))[iCondition];

  // check energy threshold and overflow
  // overflow evaluation:
  //     for condGEq >=
  //         candidate overflow true -> condition true
  //         candidate overflow false -> evaluate threshold
  //     for condGEq =
  //         candidate overflow true -> condition false
  //         candidate overflow false -> evaluate threshold
  //

  bool condGEqVal = m_gtEnergySumTemplate->condGEq();

  if (type == l1t::EtSum::EtSumType::kCentrality) {
    bool myres = checkBit(candEt, centbit);
    //std::cout << "CCLC:  Checking bit " << centbit << "\tResult is: " << myres << std::endl;
    if (!myres) {
      LogDebug("L1TGlobal") << "\t\t l1t::EtSum failed Centrality bit" << std::endl;
      return false;
    }
  } else {
    // check energy threshold
    if (!checkThreshold(objPar.etLowThreshold, objPar.etHighThreshold, candEt, condGEqVal)) {
      LogDebug("L1TGlobal") << "\t\t l1t::EtSum failed checkThreshold" << std::endl;
      return false;
    }

    if (!condGEqVal && candOverflow)
      return false;

    // for ETM and HTM check phi also
    // for overflow, the phi requirements are ignored
    if (MissingEnergy) {
      // check phi
      if (!checkRangePhi(
              candPhi, objPar.phiWindow1Lower, objPar.phiWindow1Upper, objPar.phiWindow2Lower, objPar.phiWindow2Upper)) {
        LogDebug("L1TGlobal") << "\t\t l1t::EtSum failed checkRange(phi)" << std::endl;
        return false;
      }
    }
  }

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

  objectsInComb.push_back(indexObj);
  (combinationsInCond()).push_back(objectsInComb);

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

  condResult = true;
  return condResult;
}

getuGtB()

const GlobalBoard* l1t::EnergySumCondition::getuGtB ( ) const

inline

get / set the pointer to uGt GlobalBoard

Definition at line 69 of file EnergySumCondition.h.

References m_uGtB.

{ return m_uGtB; }

gtEnergySumTemplate()

const EnergySumTemplate* l1t::EnergySumCondition::gtEnergySumTemplate ( ) const

inline

get / set the pointer to a L1GtCondition

Definition at line 64 of file EnergySumCondition.h.

References m_gtEnergySumTemplate.

{ return m_gtEnergySumTemplate; }

operator=()

l1t::EnergySumCondition & EnergySumCondition::operator=

(

const EnergySumCondition &

cp

)

Definition at line 73 of file EnergySumCondition.cc.

References filterCSVwithJSON::copy.

                                                                                       {
  copy(cp);
  return *this;
}

print()

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

overridevirtual

print condition

Reimplemented from l1t::ConditionEvaluation.

Definition at line 303 of file EnergySumCondition.cc.

References l1t::ConditionEvaluation::print().

Referenced by l1t::CorrCondition::evaluateCondition(), l1t::CorrWithOverlapRemovalCondition::evaluateCondition(), and l1t::GlobalBoard::runGTL().

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

setGtEnergySumTemplate()

void EnergySumCondition::setGtEnergySumTemplate

(

const EnergySumTemplate *

eSumTempl

)

Definition at line 79 of file EnergySumCondition.cc.

                                                                                     {
  m_gtEnergySumTemplate = eSumTempl;
}

setuGtB()

void EnergySumCondition::setuGtB

(

const GlobalBoard *

ptrGTB

)

set the pointer to uGT GlobalBoard

Definition at line 84 of file EnergySumCondition.cc.

{ m_uGtB = ptrGTB; }

Member Data Documentation

m_gtEnergySumTemplate

const EnergySumTemplate* l1t::EnergySumCondition::m_gtEnergySumTemplate

private

pointer to a EnergySumTemplate

Definition at line 79 of file EnergySumCondition.h.

Referenced by gtEnergySumTemplate().

m_uGtB

const GlobalBoard* l1t::EnergySumCondition::m_uGtB

private

pointer to uGt GlobalBoard, to be able to get the trigger objects

Definition at line 82 of file EnergySumCondition.h.

Referenced by getuGtB().