l1t::EnergySumZdcCondition Class Reference

#include <EnergySumZdcCondition.h>

Inheritance diagram for l1t::EnergySumZdcCondition:

Public Member Functions
	EnergySumZdcCondition ()
	EnergySumZdcCondition (const GlobalCondition *, const GlobalBoard *)
	from base template condition (from event setup usually) More...
	EnergySumZdcCondition (const EnergySumZdcCondition &)
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 EnergySumZdcTemplate *	gtEnergySumZdcTemplate () const
	get / set the pointer to a L1GtCondition More...
EnergySumZdcCondition &	operator= (const EnergySumZdcCondition &)
void	print (std::ostream &myCout) const override
	print condition More...
void	setGtEnergySumZdcTemplate (const EnergySumZdcTemplate *)
void	setuGtB (const GlobalBoard *)
	~EnergySumZdcCondition () 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 EnergySumZdcCondition &cp)
	copy function for copy constructor and operator= More...

Private Attributes
const EnergySumZdcTemplate *	m_gtEnergySumZdcTemplate
	pointer to a EnergySumZdcTemplate 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 deltaEta 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 deltaPhi range More...
template<class Type1 >
const bool	checkRangeEta (const unsigned int bitNumber, const std::vector< Type1 > &windows, const unsigned int nEtaBits) const
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 phi range and outside of a veto range More...
template<class Type1 >
const bool	checkRangeTfMuonIndex (const unsigned int bitNumber, const std::vector< Type1 > &windows) const
	check if a value is in a given muon track finder index 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 EnergySumZdcCondition.h.

Constructor & Destructor Documentation

EnergySumZdcCondition() [1/3]

EnergySumZdcCondition::EnergySumZdcCondition

(

)

constructors default

Definition at line 38 of file EnergySumZdcCondition.cc.

                                                : ConditionEvaluation() {
  //empty
}

EnergySumZdcCondition() [2/3]

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

from base template condition (from event setup usually)

Definition at line 43 of file EnergySumZdcCondition.cc.

References l1t::ConditionEvaluation::m_condMaxNumberObjects.

    : ConditionEvaluation(),
      m_gtEnergySumZdcTemplate(static_cast<const EnergySumZdcTemplate*>(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;
}

EnergySumZdcCondition() [3/3]

EnergySumZdcCondition::EnergySumZdcCondition

(

const EnergySumZdcCondition &

cp

)

Definition at line 67 of file EnergySumZdcCondition.cc.

References copy().

                                                                                  : ConditionEvaluation() {
  copy(cp);
}

~EnergySumZdcCondition()

EnergySumZdcCondition::~EnergySumZdcCondition ( )

overridedefault

Member Function Documentation

copy()

void EnergySumZdcCondition::copy ( const EnergySumZdcCondition &  cp )

private

copy function for copy constructor and operator=

Definition at line 56 of file EnergySumZdcCondition.cc.

Referenced by EnergySumZdcCondition().

                                                                      {
  m_gtEnergySumZdcTemplate = cp.gtEnergySumZdcTemplate();
  m_uGtB = cp.getuGtB();

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

  m_verbosity = cp.m_verbosity;
}

evaluateCondition()

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

overridevirtual

the core function to check if the condition matches

Implements l1t::ConditionEvaluation.

Definition at line 89 of file EnergySumZdcCondition.cc.

References BXVector< T >::at(), l1ct::clear(), EnergySumZdcTemplate::ObjectParameter::etHighThreshold, EnergySumZdcTemplate::ObjectParameter::etLowThreshold, BXVector< T >::getLastBX(), l1t::EtSum::getType(), l1t::gtZDCM, l1t::gtZDCP, l1t::L1Candidate::hwPt(), L1Analysis::kZDCM, L1Analysis::kZDCP, LogDebug, push_back(), and BXVector< T >::size().

                                                                             {
  // number of trigger objects in the condition: 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*>* candVecZdc = m_uGtB->getCandL1EtSumZdc();

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

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

  // If no candidates, no use looking any further
  int numberObjectsZdc = candVecZdc->size(useBx);

  if (numberObjectsZdc < 1) {
    return false;
  }

  const EnergySumZdcTemplate::ObjectParameter objPar = (*(m_gtEnergySumZdcTemplate->objectParameter()))[iCondition];
  l1t::EtSum::EtSumType type;
  switch ((m_gtEnergySumZdcTemplate->objectType())[0]) {
    case gtZDCP:
      type = l1t::EtSum::EtSumType::kZDCP;
      break;
    case gtZDCM:
      type = l1t::EtSum::EtSumType::kZDCM;
      break;
    default:
      edm::LogError("L1TGlobal")
          << "\n  Error: "
          << "Unmatched object type from template to EtSumZdcType, (m_gtEnergySumZdcTemplate->objectType())[0] = "
          << (m_gtEnergySumZdcTemplate->objectType())[0] << std::endl;
      type = l1t::EtSum::EtSumType::kZDCP;
      break;
  }

  // Definition in CondFormats/L1TObjects/interface/L1GtCondition.h:
  // condGEqVal indicates the operator used for the condition (>=, =): true for >=
  bool condGEqVal = m_gtEnergySumZdcTemplate->condGEq();

  l1t::EtSum candZdcPlus;
  l1t::EtSum candZdcMinus;
  unsigned int candZDCPEsum = 0;
  unsigned int candZDCMEsum = 0;
  bool myres = false;

  for (int iEtSum = 0; iEtSum < numberObjectsZdc; ++iEtSum) {
    l1t::EtSum candZdc = *(candVecZdc->at(useBx, iEtSum));

    if (candZdc.getType() != type)
      continue;

    if (candZdc.getType() == l1t::EtSum::EtSumType::kZDCP) {
      candZdcPlus = *(candVecZdc->at(useBx, iEtSum));
      candZDCPEsum = candZdcPlus.hwPt();
      myres = checkThreshold(objPar.etLowThreshold, objPar.etHighThreshold, candZDCPEsum, condGEqVal);
    } else if (candZdc.getType() == l1t::EtSum::EtSumType::kZDCM) {
      candZdcMinus = *(candVecZdc->at(useBx, iEtSum));
      candZDCMEsum = candZdcMinus.hwPt();
      myres = checkThreshold(objPar.etLowThreshold, objPar.etHighThreshold, candZDCMEsum, condGEqVal);
    } else {
      LogDebug("L1TGlobal") << "\t\t l1t::EtSum failed ZDC checkThreshold" << std::endl;
      return false;
    }

    LogDebug("L1TGlobal") << "CANDZdc: " << candZdc.hwPt() << ", " << useBx << ", " << candZdc.getType();

    LogDebug("L1TGlobal")
        << "----------------------------------------------> ZDC EtSumType object from EnergySumZdcTemplate"
        << "\n objPar.etLowThreshold = " << objPar.etLowThreshold
        << "\n objPar.etHighThreshold = " << objPar.etHighThreshold << "\n candZDCPEsum = " << candZDCPEsum
        << "\n candZDCMEsum = " << candZDCMEsum << "\n condGEqVal = " << condGEqVal << "\n myres = " << myres
        << std::endl;
  }

  if (not myres)
    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 successful for this combination
  // set the general result for evaluateCondition to "true"
  condResult = true;
  return condResult;
}

getuGtB()

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

inline

get / set the pointer to uGt GlobalBoard

Definition at line 69 of file EnergySumZdcCondition.h.

References m_uGtB.

{ return m_uGtB; }

gtEnergySumZdcTemplate()

const EnergySumZdcTemplate* l1t::EnergySumZdcCondition::gtEnergySumZdcTemplate ( ) const

inline

get / set the pointer to a L1GtCondition

Definition at line 64 of file EnergySumZdcCondition.h.

References m_gtEnergySumZdcTemplate.

{ return m_gtEnergySumZdcTemplate; }

operator=()

l1t::EnergySumZdcCondition & EnergySumZdcCondition::operator=

(

const EnergySumZdcCondition &

cp

)

Definition at line 75 of file EnergySumZdcCondition.cc.

References filterCSVwithJSON::copy.

                                                                                                {
  copy(cp);
  return *this;
}

print()

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

overridevirtual

print condition

Reimplemented from l1t::ConditionEvaluation.

Definition at line 196 of file EnergySumZdcCondition.cc.

References l1t::ConditionEvaluation::print().

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

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

setGtEnergySumZdcTemplate()

void EnergySumZdcCondition::setGtEnergySumZdcTemplate

(

const EnergySumZdcTemplate *

eSumTempl

)

Definition at line 81 of file EnergySumZdcCondition.cc.

                                                                                              {
  m_gtEnergySumZdcTemplate = eSumTempl;
}

setuGtB()

void EnergySumZdcCondition::setuGtB

(

const GlobalBoard *

ptrGTB

)

Definition at line 86 of file EnergySumZdcCondition.cc.

{ m_uGtB = ptrGTB; }

Member Data Documentation

m_gtEnergySumZdcTemplate

const EnergySumZdcTemplate* l1t::EnergySumZdcCondition::m_gtEnergySumZdcTemplate

private

pointer to a EnergySumZdcTemplate

Definition at line 79 of file EnergySumZdcCondition.h.

Referenced by gtEnergySumZdcTemplate().

m_uGtB

const GlobalBoard* l1t::EnergySumZdcCondition::m_uGtB

private

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

Definition at line 82 of file EnergySumZdcCondition.h.

Referenced by getuGtB().