L1GtEnergySumCondition Class Reference

#include <L1GtEnergySumCondition.h>

Inheritance diagram for L1GtEnergySumCondition:

Public Member Functions
const bool	evaluateCondition () const override
	the core function to check if the condition matches More...
const L1GtEnergySumTemplate *	gtEnergySumTemplate () const
	get / set the pointer to a L1GtCondition More...
const L1GlobalTriggerPSB *	gtPSB () const
	get / set the pointer to PSB More...
	L1GtEnergySumCondition ()
	L1GtEnergySumCondition (const L1GtCondition *, const L1GlobalTriggerPSB *)
	from base template condition (from event setup usually) More...
	L1GtEnergySumCondition (const L1GtEnergySumCondition &)
L1GtEnergySumCondition &	operator= (const L1GtEnergySumCondition &)
void	print (std::ostream &myCout) const override
	print condition More...
void	setGtEnergySumTemplate (const L1GtEnergySumTemplate *)
void	setGtPSB (const L1GlobalTriggerPSB *)
	set the pointer to PSB More...
	~L1GtEnergySumCondition () 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
void	copy (const L1GtEnergySumCondition &cp)
	copy function for copy constructor and operator= More...

Private Attributes
const L1GtEnergySumTemplate *	m_gtEnergySumTemplate
	pointer to a L1GtEnergySumTemplate More...
const L1GlobalTriggerPSB *	m_gtPSB
	pointer to PSB, to be able to get the trigger 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 CondEnergySum condition.

Implementation: <TODO: enter implementation details>

Author

: Vasile Mihai Ghete - HEPHY Vienna

Definition at line 33 of file L1GtEnergySumCondition.h.

Constructor & Destructor Documentation

L1GtEnergySumCondition() [1/3]

L1GtEnergySumCondition::L1GtEnergySumCondition

(

)

constructors default

Definition at line 40 of file L1GtEnergySumCondition.cc.

                                               : L1GtConditionEvaluation() {
  // empty
}

L1GtEnergySumCondition() [2/3]

L1GtEnergySumCondition::L1GtEnergySumCondition	(	const L1GtCondition *	eSumTemplate,
		const L1GlobalTriggerPSB *	ptrPSB
	)

from base template condition (from event setup usually)

Definition at line 45 of file L1GtEnergySumCondition.cc.

References L1GtConditionEvaluation::m_condMaxNumberObjects.

    : L1GtConditionEvaluation(),
      m_gtEnergySumTemplate(static_cast<const L1GtEnergySumTemplate *>(eSumTemplate)),
      m_gtPSB(ptrPSB)

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

  m_condMaxNumberObjects = 1;
}

L1GtEnergySumCondition() [3/3]

L1GtEnergySumCondition::L1GtEnergySumCondition

(

const L1GtEnergySumCondition &

cp

)

Definition at line 69 of file L1GtEnergySumCondition.cc.

References copy().

                                                                               : L1GtConditionEvaluation() {
  copy(cp);
}

~L1GtEnergySumCondition()

L1GtEnergySumCondition::~L1GtEnergySumCondition ( )

override

Definition at line 74 of file L1GtEnergySumCondition.cc.

                                                {
  // empty
}

Member Function Documentation

copy()

void L1GtEnergySumCondition::copy ( const L1GtEnergySumCondition &  cp )

private

copy function for copy constructor and operator=

Definition at line 58 of file L1GtEnergySumCondition.cc.

References L1GtConditionEvaluation::m_combinationsInCond, L1GtConditionEvaluation::m_condLastResult, L1GtConditionEvaluation::m_condMaxNumberObjects, m_gtEnergySumTemplate, m_gtPSB, and L1GtConditionEvaluation::m_verbosity.

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

                                                                  {
  m_gtEnergySumTemplate = cp.gtEnergySumTemplate();
  m_gtPSB = cp.gtPSB();

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

  m_verbosity = cp.m_verbosity;
}

evaluateCondition()

const bool L1GtEnergySumCondition::evaluateCondition ( ) const

overridevirtual

the core function to check if the condition matches

Implements L1GtConditionEvaluation.

Definition at line 93 of file L1GtEnergySumCondition.cc.

References L1GtConditionEvaluation::checkBit(), L1GtConditionEvaluation::checkThreshold(), clear(), L1GtConditionEvaluation::combinationsInCond(), L1GtCondition::condGEq(), L1GctEtTotal::et(), L1GctEtHad::et(), L1GctEtMiss::et(), L1GctHtMiss::et(), ETM, ETT, L1GtEnergySumTemplate::ObjectParameter::etThreshold, L1GlobalTriggerPSB::getCandL1ETM(), L1GlobalTriggerPSB::getCandL1ETT(), L1GlobalTriggerPSB::getCandL1HTM(), L1GlobalTriggerPSB::getCandL1HTT(), HTM, HTT, m_gtEnergySumTemplate, m_gtPSB, L1GtEnergySumTemplate::objectParameter(), L1GtCondition::objectType(), L1GctEtHad::overFlow(), L1GctEtTotal::overFlow(), L1GctEtMiss::overFlow(), L1GctHtMiss::overFlow(), L1GctEtMiss::phi(), L1GctHtMiss::phi(), L1GtEnergySumTemplate::ObjectParameter::phiRange0Word, L1GtEnergySumTemplate::ObjectParameter::phiRange1Word, and push_back().

                                                           {
  // 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();

  // get energy, phi (ETM and HTM) and overflow for the trigger object

  unsigned int candEt = 0;
  unsigned int candPhi = 0;
  bool candOverflow = false;

  switch ((m_gtEnergySumTemplate->objectType())[0]) {
    case ETT: {
      const L1GctEtTotal *cand1 = m_gtPSB->getCandL1ETT();

      if (cand1 == nullptr) {
        return false;
      }

      candEt = cand1->et();
      candOverflow = cand1->overFlow();

      break;
    }
    case ETM: {
      const L1GctEtMiss *cand2 = m_gtPSB->getCandL1ETM();

      if (cand2 == nullptr) {
        return false;
      }

      candEt = cand2->et();
      candPhi = cand2->phi();
      candOverflow = cand2->overFlow();

      break;
    }
    case HTT: {
      const L1GctEtHad *cand3 = m_gtPSB->getCandL1HTT();

      if (cand3 == nullptr) {
        return false;
      }

      candEt = cand3->et();
      candOverflow = cand3->overFlow();

      break;
    }
    case HTM: {
      const L1GctHtMiss *cand4 = m_gtPSB->getCandL1HTM();

      if (cand4 == nullptr) {
        return false;
      }

      candEt = cand4->et();
      candPhi = cand4->phi();
      candOverflow = cand4->overFlow();

      break;
    }
    default: {
      // should not arrive here
      return false;

      break;
    }
  }

  const L1GtEnergySumTemplate::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 (condGEqVal) {
    if (!candOverflow) {
      if (!checkThreshold(objPar.etThreshold, candEt, condGEqVal)) {
        return false;
      }
    }
  } else {
    if (candOverflow) {
      return false;
    } else {
      if (!checkThreshold(objPar.etThreshold, candEt, condGEqVal)) {
        return false;
      }
    }
  }

  // for ETM and HTM check phi also
  // for overflow, the phi requirements are ignored

  if (!candOverflow) {
    if ((m_gtEnergySumTemplate->objectType())[0] == ETM) {
      // phi bitmask is saved in two uint64_t (see parser)
      if (candPhi < 64) {
        if (!checkBit(objPar.phiRange0Word, candPhi)) {
          return false;
        }
      } else {
        if (!checkBit(objPar.phiRange1Word, candPhi - 64)) {
          return false;
        }
      }

    } else if ((m_gtEnergySumTemplate->objectType())[0] == HTM) {
      // phi bitmask is in the first word for HTM
      if (candPhi < 64) {
        if (!checkBit(objPar.phiRange0Word, candPhi)) {
          return false;
        }
      } else {
        if (!checkBit(objPar.phiRange1Word, candPhi - 64)) {
          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;
}

gtEnergySumTemplate()

const L1GtEnergySumTemplate* L1GtEnergySumCondition::gtEnergySumTemplate ( ) const

inline

get / set the pointer to a L1GtCondition

Definition at line 60 of file L1GtEnergySumCondition.h.

References m_gtEnergySumTemplate.

{ return m_gtEnergySumTemplate; }

gtPSB()

const L1GlobalTriggerPSB* L1GtEnergySumCondition::gtPSB ( ) const

inline

get / set the pointer to PSB

Definition at line 65 of file L1GtEnergySumCondition.h.

References m_gtPSB.

{ return m_gtPSB; }

operator=()

L1GtEnergySumCondition & L1GtEnergySumCondition::operator=

(

const L1GtEnergySumCondition &

cp

)

Definition at line 79 of file L1GtEnergySumCondition.cc.

References copy().

                                                                                          {
  copy(cp);
  return *this;
}

print()

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

overridevirtual

print condition

Reimplemented from L1GtConditionEvaluation.

Definition at line 251 of file L1GtEnergySumCondition.cc.

References m_gtEnergySumTemplate, L1GtConditionEvaluation::print(), and L1GtEnergySumTemplate::print().

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

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

setGtEnergySumTemplate()

void L1GtEnergySumCondition::setGtEnergySumTemplate

(

const L1GtEnergySumTemplate *

eSumTempl

)

Definition at line 85 of file L1GtEnergySumCondition.cc.

References m_gtEnergySumTemplate.

                                                                                          {
  m_gtEnergySumTemplate = eSumTempl;
}

setGtPSB()

void L1GtEnergySumCondition::setGtPSB

(

const L1GlobalTriggerPSB *

ptrPSB

)

set the pointer to PSB

Definition at line 90 of file L1GtEnergySumCondition.cc.

References m_gtPSB.

{ m_gtPSB = ptrPSB; }

Member Data Documentation

m_gtEnergySumTemplate

const L1GtEnergySumTemplate* L1GtEnergySumCondition::m_gtEnergySumTemplate

private

pointer to a L1GtEnergySumTemplate

Definition at line 75 of file L1GtEnergySumCondition.h.

Referenced by copy(), evaluateCondition(), gtEnergySumTemplate(), print(), and setGtEnergySumTemplate().

m_gtPSB

const L1GlobalTriggerPSB* L1GtEnergySumCondition::m_gtPSB

private

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

Definition at line 78 of file L1GtEnergySumCondition.h.

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