TriggerElement is the basic ingreedient of the interface between HLT algorithms and the navigation It holds navigation links by itself but they are not exposed. More...

#include <TriggerElement.h>

Collaboration diagram for HLT::TriggerElement:

Classes
class	FeatureAccessHelper
	the FeatureAccessHelper is a class used to keep track of features attached to this TE. More...

class	ObjectIndex
	Helper class for conversion from/to int stored in TE and pair of ints used in Navigation Object pointer in Navigation is pair of ints. More...

Public Types
enum	Relation { sameRoIRelation, seedsRelation, seededByRelation }
	possible relations enumeration (Note: uses no longer here) More...

enum	States { activeState = 0x1, ghostState = 0x2, nofwdState = 0x4, errorState = 0x8 }

typedef std::vector< FeatureAccessHelper >	FeatureVec

Public Member Functions
	TriggerElement ()

	TriggerElement (te_id_type id, bool ghost, bool nofwd=false)

	~TriggerElement ()

te_id_type	getId () const
	reset internals. More...

bool	getActiveState () const
	get state of the TriggerElement More...

void	setActiveState (bool state)
	set state of the TriggerElement More...

bool	ghost () const

bool	getGhostState () const

void	setGhostState (bool t=true)

void	setTransient (bool t=true)

bool	transient ()

void	setErrorState (bool state=true)

bool	getErrorState () const

const std::vector< TriggerElement * > &	getRelated (Relation rel) const
	returns reference to the likns to other TriggerElements related by relation r More...

void	relate (TriggerElement *te, Relation r)
	reates given TE to other TE More...

void	relate (const std::vector< TriggerElement * > &tes, Relation r)
	relates this TE to vecor of other TEs More...

void	serialize (std::vector< uint32_t > &output, const std::map< TriggerElement , uint16_t > &keys, const TriggerElement previous) const
	serializes TE More...

void	deserialize (std::vector< uint32_t >::const_iterator &inputIt, const std::map< uint16_t, TriggerElement * > &keys, const TriggerElement *previous)
	deserialization More...

const std::vector< FeatureAccessHelper > &	getFeatureAccessHelpers () const
	returns all features which ara attached to this TE More...

std::vector< FeatureAccessHelper > &	getFeatureAccessHelpers ()

void	addFeature (class_id_type clid, const ObjectIndex &index, bool forget=false)
	add helper for new feature More...

void	addFeature (const FeatureAccessHelper &f)

const std::vector< FeatureAccessHelper > &	getPreviousFeatures () const

std::vector< FeatureAccessHelper > &	getPreviousFeatures ()

Static Public Member Functions
static unsigned int	enquireId (std::vector< uint32_t >::const_iterator &inputIt)

Public Attributes
std::map< Relation, std::vector< TriggerElement * > >	m_relations
	relations holder (features outside) More...

Private Attributes
unsigned int	m_state
	one word for all states, info in bits (saving space in serialized object) More...

te_id_type	m_id
	id More...

bool	m_transient
	marker that TE should not be serialized More...

std::vector< FeatureAccessHelper >	m_uses
	all features attached are in this storage More...

std::vector< FeatureAccessHelper >	m_prev
	all features attached are in this TE and seeding TEs More...

Detailed Description

TriggerElement is the basic ingreedient of the interface between HLT algorithms and the navigation It holds navigation links by itself but they are not exposed.

The way to work with the navigation is only via the Navigation class.

Author: Tomasz Bold Tomas.nosp@m.z.Bo.nosp@m.ld@ce.nosp@m.rn.c.nosp@m.h - U. of California - Irvine

Definition at line 27 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

Member Typedef Documentation

◆ FeatureVec

typedef std::vector< FeatureAccessHelper > HLT::TriggerElement::FeatureVec

Definition at line 233 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

Member Enumeration Documentation

◆ Relation

enum HLT::TriggerElement::Relation

possible relations enumeration (Note: uses no longer here)

Enumerator
sameRoIRelation	equilateral relation of all TEs rooted in one RoI
seedsRelation	what TEs I am seeding
seededByRelation	what TEs are seeding me

Definition at line 116 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

                   {
       sameRoIRelation,             
       seedsRelation,               
       seededByRelation             
     };

◆ States

enum HLT::TriggerElement::States

Enumerator
activeState	this bit is keeping active/inactive state of TE
ghostState	this TE is of type ghost/evaporating/one can't attach features to this TE
nofwdState	this TE is of type which stops fwd deactivation
errorState	somewhere in the algorithms dealing with this TE there was an error

Definition at line 136 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

                 { 
       activeState = 0x1,          
       ghostState  = 0x2,          
       nofwdState  = 0x4,          
       errorState  = 0x8           
     };

Constructor & Destructor Documentation

◆ TriggerElement() [1/2]

TriggerElement::TriggerElement ( )

Definition at line 15 of file TrigNavStructure/Root/TriggerElement.cxx.

16 : m_state(activeState), m_id(0), m_transient(0) {

17 }

◆ TriggerElement() [2/2]

TriggerElement::TriggerElement	(	te_id_type	id,
		bool	ghost,
		bool	nofwd = `false`
	)

Definition at line 19 of file TrigNavStructure/Root/TriggerElement.cxx.

     : m_state(activeState), m_id(id), m_transient(0) {
     if ( ghost )
     m_state |= ghostState;
     if ( nofwd )
     m_state |= nofwdState;
 }

◆ ~TriggerElement()

TriggerElement::~TriggerElement ( )

Definition at line 27 of file TrigNavStructure/Root/TriggerElement.cxx.

27 {

28 }

Member Function Documentation

◆ addFeature() [1/2]

void TriggerElement::addFeature	(	class_id_type	clid,
		const ObjectIndex &	index,
		bool	forget = `false`
	)

add helper for new feature

Parameters

clid	the CLID of the object attached
index	an integer used to retrieve it
forget	is the flag notifying that during serialization link to this objects should be lost

Definition at line 37 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                                           {
   addFeature(FeatureAccessHelper(clid, index, forget));
 }

◆ addFeature() [2/2]

void TriggerElement::addFeature ( const FeatureAccessHelper & f )

Definition at line 41 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                              {
   const static size_t max_features_per_te = 0xfff;
   if ( m_uses.size() == max_features_per_te-1 ) {
     std::cout << "ERROR -  count of features per TE exceeds the limitation, further attach operations are ignored" << std::endl;
   }
   if ( m_uses.size() == max_features_per_te ) {
     return;
   }
   //  if ( m_uses.size() > 100 ) 
   //    std::cout << "INFO - many features per TE " << f.getCLID() << std::endl;
   m_uses.push_back( f );
   m_prev.push_back( f );
 }

◆ deserialize()

void TriggerElement::deserialize	(	std::vector< uint32_t >::const_iterator &	inputIt,
		const std::map< uint16_t, TriggerElement * > &	keys,
		const TriggerElement *	previous
	)

deserialization

Parameters

inputIt	a point where we should start reading
keys	keys wich point to the TE related by seeds relation
previous	UNUSED parameter

Definition at line 182 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                                           {
  
     m_id = *inputIt++;
     uint32_t seedingUsesStateWord = *inputIt++;
     m_state = seedingUsesStateWord & 0xf;
     unsigned int size = (seedingUsesStateWord & 0xfff00000) >> 20;
     unsigned int featuresAttached = (seedingUsesStateWord & 0x000fff00) >> 8;
     //    std::cerr << "Try DeSerialize TE id: " << m_id << " fea: " << featuresAttached << " rel: "<< size << " raw " << seedingUsesStateWord << std::endl;
  
  
  
     std::map<uint16_t, TriggerElement*>::const_iterator id;
     unsigned relationsCount = 0;
     uint16_t key{0};
     for ( unsigned int i = 0 ; i < size; ++i ) {
     extractUint16FromUint32Vector(inputIt, key, relationsCount); // extract the key from the payload
     ++relationsCount;
     // look for that key
     id = keys.find(key);
     if ( id != keys.end() ) {
         TriggerElement* te = id->second;
         //      relate ( te, seededByRelation );
         te->relate ( this, seedsRelation );
         this->relate ( te, seededByRelation ); // seededBy and seeds are reflexive ...
         m_prev.reserve(m_prev.size() + te->getPreviousFeatures().size());
         m_prev.insert(m_prev.end(), te->getPreviousFeatures().begin(), te->getPreviousFeatures().end() ); // rebuild previous features list
     }
     }
     if ( relationsCount %2 == 1 )  inputIt++; // we need to do this because if number of features is odd the payload iterator is not incremented by extract...
  
     // unpack features holders info
     m_uses.reserve(m_uses.size() + featuresAttached);
     m_prev.reserve(m_prev.size() + featuresAttached);
     for ( unsigned int i = 0 ; i < featuresAttached; ++i ) {
     unsigned int clid = *inputIt++;
     ObjectIndex coordinate;
     coordinate.deserialize(inputIt);
     addFeature(clid, coordinate);
     }
 }

◆ enquireId()

unsigned int TriggerElement::enquireId ( std::vector< uint32_t >::const_iterator & inputIt )

static

Definition at line 111 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                                    {
     return unsigned(*inputIt);
 }

◆ getActiveState()

bool HLT::TriggerElement::getActiveState ( ) const

inline

get state of the TriggerElement

Definition at line 48 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

48 { return m_state & activeState; }

◆ getErrorState()

bool HLT::TriggerElement::getErrorState ( ) const

inline

Definition at line 65 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

65 { return m_state & errorState; }

◆ getFeatureAccessHelpers() [1/2]

std::vector< FeatureAccessHelper >& HLT::TriggerElement::getFeatureAccessHelpers ( )

inline

Definition at line 239 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

239 { return m_uses; }

◆ getFeatureAccessHelpers() [2/2]

const std::vector< FeatureAccessHelper >& HLT::TriggerElement::getFeatureAccessHelpers ( ) const

inline

returns all features which ara attached to this TE

Definition at line 238 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

238 { return m_uses; }

◆ getGhostState()

bool HLT::TriggerElement::getGhostState ( ) const

inline

Definition at line 56 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

56 { return m_state & ghostState; }

◆ getId()

te_id_type HLT::TriggerElement::getId ( ) const

inline

reset internals.

Needed because of TriggerStore (or TriggerFactory ...) can be used.

gets the id of this TriggerElement

Definition at line 43 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

43 { return m_id; }

◆ getPreviousFeatures() [1/2]

std::vector<FeatureAccessHelper>& HLT::TriggerElement::getPreviousFeatures ( )

inline

Definition at line 252 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

252 {return m_prev; }

◆ getPreviousFeatures() [2/2]

const std::vector<FeatureAccessHelper>& HLT::TriggerElement::getPreviousFeatures ( ) const

inline

Definition at line 251 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

251 {return m_prev; }

◆ getRelated()

const std::vector<TriggerElement*>& HLT::TriggerElement::getRelated ( Relation rel ) const

inline

returns reference to the likns to other TriggerElements related by relation r

Parameters

rel	relation name (one of HLT::Navigation::Relation)

@return is reference ot the vector of related TEs

Definition at line 127 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

                                                                               {
       auto it = m_relations.find (rel);
       if (it != m_relations.end()) {
         return it->second;
       }
       static const std::vector<TriggerElement*> dumvec;
       return dumvec;
     }

◆ ghost()

bool HLT::TriggerElement::ghost ( ) const

inline

Definition at line 55 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

55 { return m_state & ghostState; }

◆ relate() [1/2]

void TriggerElement::relate	(	const std::vector< TriggerElement * > &	tes,
		Relation	r
	)

relates this TE to vecor of other TEs

Parameters

tes	vector of TriggerElement pointers
r	relation .. one of Relation enums

Definition at line 95 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                                                {
     // secure form multiple relations of the same type
     std::vector<TriggerElement*>::const_iterator it;
     for ( it = tes.begin(); it != tes.end(); ++it ) {
     relate(*it, r);
     }
 }

◆ relate() [2/2]

void TriggerElement::relate	(	TriggerElement *	te,
		Relation	r
	)

reates given TE to other TE

Parameters

te	TriggerElement pointer
r	relation .. one of Relation enums Nothe that the relation is usually reflexive ...

Definition at line 86 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                             {
     // secure form multiple relations of the same type
     // silently ignoring if already related
     // his helps if one wants the Topo TE to merge several RoIs
     if ( find(m_relations[r].begin(), m_relations[r].end(), te) ==  m_relations[r].end() )
     m_relations[r].push_back(te);
 }

◆ serialize()

void TriggerElement::serialize	(	std::vector< uint32_t > &	output,
		const std::map< TriggerElement *, uint16_t > &	keys,
		const TriggerElement *	previous
	)		const

serializes TE

Parameters

output	is vector of raw integers where to put serialized TE
keys	is a map from pointers to ksys ... this keas go to serializized TE
previous	UNUSED parameter

Definition at line 134 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                 {
  
     output.push_back(m_id);   // record the TE id first
     unsigned summaryIndex = output.size();  // reserve space for vaious caounters and state
     output.push_back(0);
  
     auto it = m_relations.find (seededByRelation);
     std::vector<TriggerElement*> dumvec;
     const std::vector<TriggerElement*>& relvec =
       (it != m_relations.end() ? it->second : dumvec);
  
     std::vector<TriggerElement*>::const_iterator teIt;
     unsigned relationsCount = 0;
     // go over all TE which seed me and record link to them
     for ( teIt = relvec.begin(); teIt != relvec.end(); ++teIt ) {
     std::map<TriggerElement*, uint16_t>::const_iterator key = keys.find(*teIt);
     if ( key != keys.end() ) {
         insertUint16ToUint32Vector(output, key->second, relationsCount);
         relationsCount++;
     } 
     // other are forgotten silently .... joke, there will be none
     // due to fact that the to create TE one needs to know all the TEs seeding it
     // so they are before on the list and in the "keys" map
     }
  
     // here one should put only this features which are not to to be forget (we do not use this now)
     std::vector< FeatureAccessHelper >::const_iterator featuresIt;
     unsigned featuresCount = 0;
  
     for ( featuresIt = m_uses.begin(); featuresIt != m_uses.end(); ++featuresIt ) {
     if ( ! featuresIt->forget() ) {
         output.push_back ( featuresIt->getCLID() );
         featuresIt->getIndex().serialize(output);
         featuresCount++;
     }
     }
     uint32_t seedingUsesStateWord = ((relvec.size() << 20)) | (featuresCount << 8) | (m_state & 0xf);
     output[summaryIndex] = seedingUsesStateWord;
     /*
     std::cerr << "Serialized TE id: " << m_id << " fea: " << featuresCount 
           <<  " forg: "  << m_uses.size() - featuresCount
           << " rel: "<< m_relations[seededByRelation].size() << " raw: " << seedingUsesStateWord<< std::endl;
     */
 }

◆ setActiveState()

void TriggerElement::setActiveState ( bool state )

set state of the TriggerElement

Definition at line 55 of file TrigNavStructure/Root/TriggerElement.cxx.

                                                 {
     if ( m_state & nofwdState ) // this TE is immune to state changes 
     return;
  
     state ? m_state |= activeState :  m_state &= ~activeState;
     //  std::cerr << "Deactivating " << m_id  << std::endl;
     // propagate forward the state of this TE if deactivated
     // if activated then that attempt is illogical, theredore not done
  
     if ( state == true )
     return;
  
     // this node is terminal or it is special TE type which is holding fwd deactivation
     if ( getRelated(seedsRelation).empty() )
     return;
  
     //  std::cerr << "Propagating deactivation "  << std::endl;
     std::vector<TriggerElement*>::const_iterator it;
     for ( it = getRelated(seedsRelation).begin(); it != getRelated(seedsRelation).end(); ++it ) {
     (*it)->setActiveState(false);
     }
 }

◆ setErrorState()

void TriggerElement::setErrorState ( bool state = true )

Definition at line 78 of file TrigNavStructure/Root/TriggerElement.cxx.

                                              {
     state ? m_state |= errorState : m_state &= ~errorState; 
 }

◆ setGhostState()

void TriggerElement::setGhostState ( bool t = true )

Definition at line 82 of file TrigNavStructure/Root/TriggerElement.cxx.

                                               {
   state ? m_state |= ghostState : m_state &= ~ghostState;  
 }

◆ setTransient()

void HLT::TriggerElement::setTransient ( bool t = true )

inline

Definition at line 59 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

59 { m_transient = t; }

◆ transient()

bool HLT::TriggerElement::transient ( )

inline

Definition at line 60 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

60 { return m_transient; }

Member Data Documentation

◆ m_id

te_id_type HLT::TriggerElement::m_id

private

id

Definition at line 257 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

◆ m_prev

std::vector< FeatureAccessHelper > HLT::TriggerElement::m_prev

private

all features attached are in this TE and seeding TEs

Definition at line 260 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

◆ m_relations

std::map<Relation, std::vector<TriggerElement*> > HLT::TriggerElement::m_relations

relations holder (features outside)

Definition at line 143 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

◆ m_state

unsigned int HLT::TriggerElement::m_state

private

one word for all states, info in bits (saving space in serialized object)

Definition at line 256 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

◆ m_transient

bool HLT::TriggerElement::m_transient

private

marker that TE should not be serialized

Definition at line 258 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

◆ m_uses

std::vector< FeatureAccessHelper > HLT::TriggerElement::m_uses

private

all features attached are in this storage

Definition at line 259 of file TrigNavStructure/TrigNavStructure/TriggerElement.h.

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FeatureVec

Member Enumeration Documentation

◆ Relation

◆ States

Constructor & Destructor Documentation

◆ TriggerElement() [1/2]

◆ TriggerElement() [2/2]

◆ ~TriggerElement()

Member Function Documentation

◆ addFeature() [1/2]

◆ addFeature() [2/2]

◆ deserialize()

◆ enquireId()

◆ getActiveState()

◆ getErrorState()

◆ getFeatureAccessHelpers() [1/2]

◆ getFeatureAccessHelpers() [2/2]

◆ getGhostState()

◆ getId()

◆ getPreviousFeatures() [1/2]

◆ getPreviousFeatures() [2/2]

◆ getRelated()

@return is reference ot the vector of related TEs

◆ ghost()

◆ relate() [1/2]

◆ relate() [2/2]

◆ serialize()

◆ setActiveState()

◆ setErrorState()

◆ setGhostState()

◆ setTransient()

◆ transient()

Member Data Documentation

◆ m_id

◆ m_prev

◆ m_relations

◆ m_state

◆ m_transient

◆ m_uses