l1t::ExternalCondition Class Reference

#include <ExternalCondition.h>

Inheritance diagram for l1t::ExternalCondition:

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

Private Attributes
const ExternalTemplate *	m_gtExternalTemplate
	pointer to a ExternalTemplate 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
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 ExternalCondition.h.

Constructor & Destructor Documentation

ExternalCondition::ExternalCondition

(

)

constructors default

Definition at line 38 of file ExternalCondition.cc.

                                        :
    ConditionEvaluation() {

    //empty

}

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

from base template condition (from event setup usually)

Definition at line 46 of file ExternalCondition.cc.

References l1t::ConditionEvaluation::m_condMaxNumberObjects.

                                                                                                      :
    ConditionEvaluation(),
    m_gtExternalTemplate(static_cast<const ExternalTemplate*>(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;  //blw ???

}

ExternalCondition::ExternalCondition

(

const ExternalCondition &

cp

)

Definition at line 74 of file ExternalCondition.cc.

References copy().

                                                                      :
    ConditionEvaluation() {

    copy(cp);

}

ExternalCondition::~ExternalCondition ( )

override

Definition at line 82 of file ExternalCondition.cc.

                                         {

    // empty

}

Member Function Documentation

void ExternalCondition::copy ( const ExternalCondition &  cp )

private

copy function for copy constructor and operator=

Definition at line 61 of file ExternalCondition.cc.

References l1t::ConditionEvaluation::condLastResult(), l1t::ConditionEvaluation::condMaxNumberObjects(), l1t::ConditionEvaluation::getCombinationsInCond(), getuGtB(), gtExternalTemplate(), l1t::ConditionEvaluation::m_combinationsInCond, l1t::ConditionEvaluation::m_condLastResult, l1t::ConditionEvaluation::m_condMaxNumberObjects, m_gtExternalTemplate, m_uGtB, and l1t::ConditionEvaluation::m_verbosity.

Referenced by ExternalCondition(), getuGtB(), and operator=().

                                                              {

    m_gtExternalTemplate = cp.gtExternalTemplate();
    m_uGtB = cp.getuGtB();

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

    m_verbosity = cp.m_verbosity;

}

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

overridevirtual

the core function to check if the condition matches

Implements l1t::ConditionEvaluation.

Definition at line 110 of file ExternalCondition.cc.

References BXVector< T >::at(), hitfit::clear(), l1t::ConditionEvaluation::combinationsInCond(), GlobalCondition::condName(), GlobalCondition::condRelativeBx(), ExternalTemplate::extChannel(), l1t::GlobalBoard::getCandL1External(), GlobalExtBlk::getExternalDecision(), BXVector< T >::getLastBX(), LogDebug, m_gtExternalTemplate, m_uGtB, and BXVector< T >::size().

                                                                         {



    LogDebug("L1TGlobal") << "Evaluating External Condition " 
                          <<  m_gtExternalTemplate->condName() 
              << " on Channel "  << m_gtExternalTemplate->extChannel() 
              << " relative Bx " << m_gtExternalTemplate->condRelativeBx() << std::endl;
    // 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 GlobalExtBlk*>* candVec = m_uGtB->getCandL1External();

    // Look at objects in bx = bx + relativeBx
    int useBx = bxEval + m_gtExternalTemplate->condRelativeBx();
    unsigned int exCondCh = m_gtExternalTemplate->extChannel(); 

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

    int numberObjects = candVec->size(useBx);
    if (numberObjects < 1) {
        return false;
    }

    //get external block (should only be one for the bx)
    GlobalExtBlk ext = *(candVec->at(useBx,0));
    //ext.print(std::cout);

    // check external bit
    if ( !ext.getExternalDecision(exCondCh) ) {
      LogDebug("L1TGlobal") << "\t\t External Condition was not set" << std::endl;
        return false;
    }

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

    //Do we need this?
    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;
    LogDebug("L1TGlobal") << "\t\t Congrats, External Condition was set!" << std::endl;
    
    return condResult;

}

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

inline

get / set the pointer to uGt GlobalBoard

Definition at line 76 of file ExternalCondition.h.

References copy(), SimDataFormats::CaloAnalysis::cp, m_uGtB, and setuGtB().

Referenced by copy().

                                              {
        return m_uGtB;
    }

const ExternalTemplate* l1t::ExternalCondition::gtExternalTemplate ( ) const

inline

get / set the pointer to a L1GtCondition

Definition at line 69 of file ExternalCondition.h.

References m_gtExternalTemplate, and setGtExternalTemplate().

Referenced by copy().

                                                              {
        return m_gtExternalTemplate;
    }

l1t::ExternalCondition & ExternalCondition::operator=

(

const ExternalCondition &

cp

)

Definition at line 89 of file ExternalCondition.cc.

References copy().

{
    copy(cp);
    return *this;
}

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

overridevirtual

print condition

Reimplemented from l1t::ConditionEvaluation.

Definition at line 179 of file ExternalCondition.cc.

References m_gtExternalTemplate, ExternalTemplate::print(), and l1t::ConditionEvaluation::print().

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

                                                         {

    m_gtExternalTemplate->print(myCout);
    ConditionEvaluation::print(myCout);

}

void ExternalCondition::setGtExternalTemplate

(

const ExternalTemplate *

eSumTempl

)

Definition at line 96 of file ExternalCondition.cc.

References m_gtExternalTemplate.

Referenced by gtExternalTemplate().

                                                                                  {

    m_gtExternalTemplate = eSumTempl;

}

void ExternalCondition::setuGtB

(

const GlobalBoard *

ptrGTB

)

set the pointer to uGT GlobalBoard

Definition at line 103 of file ExternalCondition.cc.

References m_uGtB.

Referenced by getuGtB().

                                                            {

    m_uGtB = ptrGTB;

}

Member Data Documentation

const ExternalTemplate* l1t::ExternalCondition::m_gtExternalTemplate

private

pointer to a ExternalTemplate

Definition at line 90 of file ExternalCondition.h.

Referenced by copy(), evaluateCondition(), gtExternalTemplate(), print(), and setGtExternalTemplate().

const GlobalBoard* l1t::ExternalCondition::m_uGtB

private

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

Definition at line 93 of file ExternalCondition.h.

Referenced by copy(), evaluateCondition(), getuGtB(), and setuGtB().