CorrelationTemplate Class Reference

#include <CorrelationTemplate.h>

Inheritance diagram for CorrelationTemplate:

Classes
struct	CorrelationParameter
	typedef for correlation parameters More...

Public Member Functions
const l1t::GtConditionCategory	cond0Category () const
	get / set the category of the two sub-conditions More...
const int	cond0Index () const
	get / set the index of the two sub-conditions in the cor* vector from menu More...
const l1t::GtConditionCategory	cond1Category () const
const int	cond1Index () const
const CorrelationParameter *	correlationParameter () const
	get / set correlation parameters More...
	CorrelationTemplate ()
	CorrelationTemplate (const std::string &)
	from condition name More...
	CorrelationTemplate (const std::string &, const l1t::GtConditionCategory &, const l1t::GtConditionCategory &, const int, const int)
	CorrelationTemplate (const CorrelationTemplate &)
	copy constructor More...
CorrelationTemplate &	operator= (const CorrelationTemplate &)
	assign operator More...
virtual void	print (std::ostream &myCout) const
	print the condition More...
void	setCond0Category (const l1t::GtConditionCategory &)
void	setCond0Index (const int &)
void	setCond1Category (const l1t::GtConditionCategory &)
void	setCond1Index (const int &)
void	setCorrelationParameter (const CorrelationParameter &corrParameter)
virtual	~CorrelationTemplate ()
	destructor More...
Public Member Functions inherited from GtCondition
const l1t::GtConditionCategory &	condCategory () const
	get / set the category of the condition More...
const int &	condChipNr () const
	get / set the condition-chip number the condition is located on More...
const bool	condGEq () const
	get / set condition GEq flag More...
const std::string &	condName () const
	get / set condition name More...
const int &	condRelativeBx () const
	get / set the condition relative bx More...
const l1t::GtConditionType &	condType () const
	get / set the type of the condition (1s, etc) More...
const bool	corr () const
	GtCondition ()
	GtCondition (const std::string &)
	constructor from condition name More...
	GtCondition (const std::string &, const l1t::GtConditionCategory &, const l1t::GtConditionType &)
	constructor from condition name, category and type More...
const int	nrObjects () const
	get number of trigger objects More...
const std::vector< L1GtObject > &	objectType () const
	get / set the trigger object type(s) in the condition More...
void	setCondCategory (const l1t::GtConditionCategory &cCategory)
void	setCondChipNr (const int &cChipNr)
void	setCondGEq (const bool &cGEq)
void	setCondName (const std::string &cName)
void	setCondRelativeBx (const int &cRelativeBx)
void	setCondType (const l1t::GtConditionType &cType)
void	setObjectType (const std::vector< L1GtObject > &objType)
const bool	wsc () const
virtual	~GtCondition ()
	destructor More...

Private Member Functions
void	copy (const CorrelationTemplate &cp)
	copy function for copy constructor and operator= More...

Private Attributes
l1t::GtConditionCategory	m_cond0Category
int	m_cond0Index
l1t::GtConditionCategory	m_cond1Category
int	m_cond1Index
CorrelationParameter	m_correlationParameter

Friends
std::ostream &	operator<< (std::ostream &, const CorrelationTemplate &)
	output stream operator More...

Additional Inherited Members
Protected Attributes inherited from GtCondition
l1t::GtConditionCategory	m_condCategory
	the category of the condition More...
int	m_condChipNr
	condition is located on condition chip m_condChipNr More...
bool	m_condGEq
	the operator used for the condition (>=, =): true for >= More...
std::string	m_condName
	the name of the condition More...
int	m_condRelativeBx
l1t::GtConditionType	m_condType
	the type of the condition (1s, etc) More...
std::vector< L1GtObject >	m_objectType
	the trigger object type(s) More...

Detailed Description

Description: L1 Global Trigger correlation template. Includes spatial correlation for two objects of different type.

Implementation: <TODO: enter implementation details>

Author

: Vasile Mihai Ghete - HEPHY Vienna

$Date$ $Revision$

Definition at line 37 of file CorrelationTemplate.h.

Constructor & Destructor Documentation

CorrelationTemplate::CorrelationTemplate

(

)

constructor(s) default

Definition at line 34 of file CorrelationTemplate.cc.

References l1t::CondCorrelation, l1t::CondNull, m_cond0Category, m_cond0Index, m_cond1Category, m_cond1Index, GtCondition::m_condCategory, GtCondition::m_condChipNr, GtCondition::m_condType, GtCondition::m_objectType, GtCondition::nrObjects(), and l1t::Type2cor.

        : GtCondition()
{

    m_condCategory = l1t::CondCorrelation;
    m_condType = l1t::Type2cor;
    m_condChipNr = -1;

    // there are in fact two objects
    int nObjects = nrObjects();

    if (nObjects > 0) {
        m_objectType.reserve(nObjects);
    }

    m_cond0Category = l1t::CondNull;
    m_cond1Category = l1t::CondNull;
    m_cond0Index = -1;
    m_cond1Index = -1;

}

CorrelationTemplate::CorrelationTemplate

(

const std::string &

cName

)

from condition name

Definition at line 57 of file CorrelationTemplate.cc.

References l1t::CondCorrelation, l1t::CondNull, m_cond0Category, m_cond0Index, m_cond1Category, m_cond1Index, GtCondition::m_condCategory, GtCondition::m_condChipNr, GtCondition::m_condType, GtCondition::m_objectType, GtCondition::nrObjects(), and l1t::Type2cor.

        : GtCondition(cName)
{

    m_condCategory = l1t::CondCorrelation;
    m_condType = l1t::Type2cor;
    m_condChipNr = -1;

    // there are in fact two objects
    int nObjects = nrObjects();

    if (nObjects > 0) {
        m_objectType.reserve(nObjects);
    }

    m_cond0Category = l1t::CondNull;
    m_cond1Category = l1t::CondNull;
    m_cond0Index = -1;
    m_cond1Index = -1;

}

CorrelationTemplate::CorrelationTemplate	(	const std::string &	cName,
		const l1t::GtConditionCategory &	cond0Cat,
		const l1t::GtConditionCategory &	cond1Cat,
		const int	cond0Index,
		const int	cond1index
	)

from condition name, the category of first sub-condition, the category of the second sub-condition, the index of first sub-condition in the cor* vector, the index of second sub-condition in the cor* vector

Definition at line 82 of file CorrelationTemplate.cc.

References l1t::CondCorrelation, GtCondition::m_condCategory, GtCondition::m_condChipNr, GtCondition::m_condType, GtCondition::m_objectType, GtCondition::nrObjects(), and l1t::Type2cor.

                              :
    GtCondition(cName),
            m_cond0Category(cond0Cat),
            m_cond1Category(cond1Cat),
            m_cond0Index(cond0Index),
            m_cond1Index(cond1index)

{

    m_condCategory = l1t::CondCorrelation;
    m_condType = l1t::Type2cor;
    m_condChipNr = -1;

    // there are in fact two objects
    int nObjects = nrObjects();

    if (nObjects> 0) {
        m_objectType.resize(nObjects);
    }
}

CorrelationTemplate::CorrelationTemplate

(

const CorrelationTemplate &

cp

)

copy constructor

Definition at line 108 of file CorrelationTemplate.cc.

References copy().

        : GtCondition(cp.m_condName)
{
    copy(cp);
}

CorrelationTemplate::~CorrelationTemplate ( )

virtual

destructor

Definition at line 115 of file CorrelationTemplate.cc.

{
    // empty now
}

Member Function Documentation

const l1t::GtConditionCategory CorrelationTemplate::cond0Category ( ) const

inline

get / set the category of the two sub-conditions

Definition at line 91 of file CorrelationTemplate.h.

References m_cond0Category.

Referenced by copy(), and l1t::GtBoard::runGTL().

                                                              {
        return m_cond0Category;
    }

const int CorrelationTemplate::cond0Index ( ) const

inline

get / set the index of the two sub-conditions in the cor* vector from menu

Definition at line 103 of file CorrelationTemplate.h.

References m_cond0Index.

Referenced by copy(), and l1t::GtBoard::runGTL().

                                        {
        return m_cond0Index;
    }

const l1t::GtConditionCategory CorrelationTemplate::cond1Category ( ) const

inline

Definition at line 95 of file CorrelationTemplate.h.

References m_cond1Category.

Referenced by copy(), and l1t::GtBoard::runGTL().

                                                              {
        return m_cond1Category;
    }

const int CorrelationTemplate::cond1Index ( ) const

inline

Definition at line 107 of file CorrelationTemplate.h.

References m_cond1Index.

Referenced by copy(), and l1t::GtBoard::runGTL().

                                        {
        return m_cond1Index;
    }

void CorrelationTemplate::copy ( const CorrelationTemplate &  cp )

private

copy function for copy constructor and operator=

Definition at line 190 of file CorrelationTemplate.cc.

References cond0Category(), cond0Index(), cond1Category(), cond1Index(), GtCondition::condCategory(), GtCondition::condChipNr(), GtCondition::condGEq(), GtCondition::condName(), GtCondition::condType(), correlationParameter(), m_cond0Category, m_cond0Index, m_cond1Category, m_cond1Index, GtCondition::m_condCategory, GtCondition::m_condChipNr, GtCondition::m_condGEq, GtCondition::m_condName, GtCondition::m_condType, m_correlationParameter, GtCondition::m_objectType, and GtCondition::objectType().

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

{

    m_condName     = cp.condName();
    m_condCategory = cp.condCategory();
    m_condType     = cp.condType();
    m_objectType   = cp.objectType();
    m_condGEq      = cp.condGEq();
    m_condChipNr   = cp.condChipNr();

    m_cond0Category = cp.cond0Category();
    m_cond1Category = cp.cond1Category();
    m_cond0Index = cp.cond0Index();
    m_cond1Index = cp.cond1Index();

    m_correlationParameter = *(cp.correlationParameter());

}

const CorrelationParameter* CorrelationTemplate::correlationParameter ( ) const

inline

get / set correlation parameters

Definition at line 116 of file CorrelationTemplate.h.

References m_correlationParameter.

Referenced by copy().

    {
        return &m_correlationParameter;
    }

CorrelationTemplate & CorrelationTemplate::operator=

(

const CorrelationTemplate &

cp

)

assign operator

Definition at line 121 of file CorrelationTemplate.cc.

References copy().

{

    copy(cp);
    return *this;
}

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

virtual

print the condition

Reimplemented from GtCondition.

Definition at line 160 of file CorrelationTemplate.cc.

References CorrelationTemplate::CorrelationParameter::chargeCorrelation, CorrelationTemplate::CorrelationParameter::corrCutType, TauDecayModes::dec, CorrelationTemplate::CorrelationParameter::deltaEtaRange, CorrelationTemplate::CorrelationParameter::deltaPhiMaxbits, CorrelationTemplate::CorrelationParameter::deltaPhiRange, m_cond0Category, m_cond0Index, m_cond1Category, m_cond1Index, m_correlationParameter, CorrelationTemplate::CorrelationParameter::maxCutValue, CorrelationTemplate::CorrelationParameter::minCutValue, and GtCondition::print().

Referenced by operator<<(), l1t::TriggerMenuParser::parseCorrelation(), and l1t::TriggerMenuXmlParser::parseCorrelationV2().

{

    myCout << "\n  CorrelationTemplate print..." << std::endl;

    GtCondition::print(myCout);

    myCout << "\n  First sub-condition category:  " << m_cond0Category <<  std::endl;
    myCout <<   "  Second sub-condition category: " << m_cond1Category <<  std::endl;

    myCout << "\n  First sub-condition index:  " << m_cond0Index <<  std::endl;
    myCout <<   "  Second sub-condition index: " << m_cond1Index <<  std::endl;

    myCout << "\n  Correlation parameters " << "[ hex ]" <<  std::endl;

    myCout << "    Cut Type:  " << m_correlationParameter.corrCutType << std::endl;
    myCout << "    deltaEtaRange      = "
    << std::hex << m_correlationParameter.deltaEtaRange << std::endl;
    myCout << "    deltaPhiRange      = "
    << std::hex << m_correlationParameter.deltaPhiRange << std::endl;
    myCout << "    deltaPhiMaxbits    = "
    << std::hex << m_correlationParameter.deltaPhiMaxbits << std::endl;
    myCout << "    minCutValue        = " << std::dec << m_correlationParameter.minCutValue << std::endl;
    myCout << "    maxCutValue        = " << std::dec << m_correlationParameter.maxCutValue << std::endl;
    myCout << "    chargeCorrelation  = " << std::dec << m_correlationParameter.chargeCorrelation << std::endl;

    // reset to decimal output
    myCout << std::dec << std::endl;
}

void CorrelationTemplate::setCond0Category

(

const l1t::GtConditionCategory &

condCateg

)

Definition at line 129 of file CorrelationTemplate.cc.

References m_cond0Category.

Referenced by l1t::TriggerMenuParser::parseCorrelation(), and l1t::TriggerMenuXmlParser::parseCorrelationV2().

                                                 {

    m_cond0Category = condCateg;
}

void CorrelationTemplate::setCond0Index

(

const int &

condIndex

)

Definition at line 143 of file CorrelationTemplate.cc.

References m_cond0Index.

Referenced by l1t::TriggerMenuParser::parseCorrelation(), and l1t::TriggerMenuXmlParser::parseCorrelationV2().

                                                            {
    m_cond0Index = condIndex;
}

void CorrelationTemplate::setCond1Category

(

const l1t::GtConditionCategory &

condCateg

)

Definition at line 135 of file CorrelationTemplate.cc.

References m_cond1Category.

Referenced by l1t::TriggerMenuParser::parseCorrelation(), and l1t::TriggerMenuXmlParser::parseCorrelationV2().

                                                 {

    m_cond1Category = condCateg;
}

void CorrelationTemplate::setCond1Index

(

const int &

condIndex

)

Definition at line 147 of file CorrelationTemplate.cc.

References m_cond1Index.

Referenced by l1t::TriggerMenuParser::parseCorrelation(), and l1t::TriggerMenuXmlParser::parseCorrelationV2().

                                                            {
    m_cond1Index = condIndex;
}

void CorrelationTemplate::setCorrelationParameter

(

const CorrelationParameter &

corrParameter

)

Definition at line 153 of file CorrelationTemplate.cc.

References m_correlationParameter.

Referenced by l1t::TriggerMenuParser::parseCorrelation(), and l1t::TriggerMenuXmlParser::parseCorrelationV2().

                                                   {

    m_correlationParameter = corrParameter;

}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const CorrelationTemplate &  result  )

friend

output stream operator

Definition at line 210 of file CorrelationTemplate.cc.

{
    result.print(os);
    return os;

}

Member Data Documentation

l1t::GtConditionCategory CorrelationTemplate::m_cond0Category

private

Definition at line 139 of file CorrelationTemplate.h.

Referenced by cond0Category(), copy(), CorrelationTemplate(), print(), and setCond0Category().

int CorrelationTemplate::m_cond0Index

private

Definition at line 141 of file CorrelationTemplate.h.

Referenced by cond0Index(), copy(), CorrelationTemplate(), print(), and setCond0Index().

l1t::GtConditionCategory CorrelationTemplate::m_cond1Category

private

Definition at line 140 of file CorrelationTemplate.h.

Referenced by cond1Category(), copy(), CorrelationTemplate(), print(), and setCond1Category().

int CorrelationTemplate::m_cond1Index

private

Definition at line 142 of file CorrelationTemplate.h.

Referenced by cond1Index(), copy(), CorrelationTemplate(), print(), and setCond1Index().

CorrelationParameter CorrelationTemplate::m_correlationParameter

private

Definition at line 143 of file CorrelationTemplate.h.

Referenced by copy(), correlationParameter(), print(), and setCorrelationParameter().