#include <eFEXFormTOBs.h>

Inheritance diagram for LVL1::eFEXFormTOBs:

Collaboration diagram for LVL1::eFEXFormTOBs:

Public Member Functions
	eFEXFormTOBs (const std::string &type, const std::string &name, const IInterface *parent)
	Constructors.
virtual StatusCode	initialize ()
	standard Athena-Algorithm method
virtual	~eFEXFormTOBs ()
	Destructor.
virtual uint32_t	formTauTOBWord (int, int, int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int) const
virtual std::vector< uint32_t >	formTauxTOBWords (int, int, int, int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int) const
virtual uint32_t	formEmTOBWord (int, int, int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int) const
virtual std::vector< uint32_t >	formEmxTOBWords (int, int, int, int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int, unsigned int) const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const unsigned int	m_tobETshift = 2
	Internal data.
const unsigned int	m_fpgaShift = 30
const unsigned int	m_etaShift = 27
const unsigned int	m_phiShift = 24
const unsigned int	m_rhadShift = 22
const unsigned int	m_wstotShift = 20
const unsigned int	m_retaShift = 18
const unsigned int	m_seedShift = 16
const unsigned int	m_undShift = 15
const unsigned int	m_seedMaxShift = 14
const unsigned int	m_shelfShift = 24
const unsigned int	m_efexShift = 20
const unsigned int	m_taurhadShift = 20
const unsigned int	m_taurcoreShift = 18
const unsigned int	m_algoVersionShift = 12
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 24 of file eFEXFormTOBs.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ eFEXFormTOBs()

LVL1::eFEXFormTOBs::eFEXFormTOBs	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructors.

Definition at line 18 of file eFEXFormTOBs.cxx.

                                                                                                :
  AthAlgTool(type, name, parent)
  {
    declareInterface<eFEXFormTOBs>(this);
  }

◆ ~eFEXFormTOBs()

LVL1::eFEXFormTOBs::~eFEXFormTOBs ( )

virtual

Destructor.

Desctructor.

Definition at line 25 of file eFEXFormTOBs.cxx.

26{

27}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ formEmTOBWord()

uint32_t LVL1::eFEXFormTOBs::formEmTOBWord	(	int	fpga,
		int	eta,
		int	phi,
		unsigned int	rhad,
		unsigned int	wstot,
		unsigned int	reta,
		unsigned int	seed,
		unsigned int	und,
		unsigned int	et,
		unsigned int	ptMinTopo,
		unsigned int	algoVersion ) const

virtual

Definition at line 99 of file eFEXFormTOBs.cxx.

{
  uint32_t tobWord = 0;
 
  // rescale from eFEX scale (25 MeV) to TOB scale (100 MeV)
  // Do this using a bit shift to keep this 100% integer
  unsigned int etTob = (et>>m_tobETshift);
 
  // If ET < minimum value return empty TOB
  if (etTob < ptMinTopo) return tobWord;
 
  // Truncate at 12 bits, set to max value of 4095, 0xfff, or 111111111111
  if (etTob > 0xfff) etTob = 0xfff;
 
  // Create bare minimum tob word with et, eta, phi, and fpga index, bitshifted to the appropriate locations
  tobWord = (fpga << m_fpgaShift) + (eta << m_etaShift) + (phi << m_phiShift) + (rhad << m_rhadShift) + (wstot << m_wstotShift) + (reta << m_retaShift) + (seed << m_seedShift) + (und << m_undShift) + (0x1 << m_seedMaxShift) + etTob + (algoVersion << m_algoVersionShift);
 
  ATH_MSG_DEBUG("EM tobword: " << std::bitset<32>(tobWord) );
 
  return tobWord;
}

◆ formEmxTOBWords()

std::vector< uint32_t > LVL1::eFEXFormTOBs::formEmxTOBWords	(	int	efexid,
		int	fpga,
		int	eta,
		int	phi,
		unsigned int	rhad,
		unsigned int	wstot,
		unsigned int	reta,
		unsigned int	seed,
		unsigned int	und,
		unsigned int	et,
		unsigned int	ptMinTopo,
		unsigned int	algoVersion ) const

virtual

Definition at line 122 of file eFEXFormTOBs.cxx.

{
  std::vector<uint32_t> tobWords = {0, 0};
 
  // If ET < minimum return empty xTOB. Threshold is at TOB scale, so rescale ET before applying
  if ((et >> m_tobETshift) < ptMinTopo) return tobWords;
 
  // Truncate ET at 16 bits, set to max value of 0xffff
  unsigned int etTob = (et < 0xffff ? et : 0xffff);
 
  // Calculate shelf and eFEX numbers from the efex index
  uint8_t shelf = int(efexid/12);
  uint8_t efex  = efexid%12;
 
  // Create tob word 0 with eta, phi, and fpga index, bitshifted to the appropriate locations
  tobWords[0] = (fpga << m_fpgaShift) + (eta << m_etaShift) + (phi << m_phiShift) + (rhad << m_rhadShift) + (wstot << m_wstotShift) + (reta << m_retaShift) + (seed << m_seedShift) + (und << m_undShift) + (0x1 << m_seedMaxShift) + (algoVersion << m_algoVersionShift);
 
  // Create tob word 1 with et, efex and shelf indices, bitshifted to the appropriate locations
  tobWords[1] = (shelf << m_shelfShift) + (efex << m_efexShift) + etTob;
 
  ATH_MSG_DEBUG("EM xtobwords: " << std::bitset<32>(tobWords[0]) << ", " << std::bitset<32>(tobWords[1]));
 
  return tobWords;
}

◆ formTauTOBWord()

uint32_t LVL1::eFEXFormTOBs::formTauTOBWord	(	int	fpga,
		int	eta,
		int	phi,
		unsigned int	et,
		unsigned int	rhad,
		unsigned int	rcore,
		unsigned int	seed,
		unsigned int	und,
		unsigned int	ptMinTopo,
		unsigned int	algoVersion ) const

virtual

Definition at line 34 of file eFEXFormTOBs.cxx.

{
  uint32_t tobWord = 0;
 
  if(algoVersion>0) {
      und = 0; // no und bit in BDT TOBs
  }
 
  //rescale from eFEX scale (25 MeV) to TOB scale (100 MeV)
  // Do this using a bit shift to keep this 100% integer
  unsigned int etTob = (et>>m_tobETshift);
 
  // If ET < minimum value return empty TOB
  if (etTob < ptMinTopo) return tobWord;
 
  // Truncate at 12 bits, set to max value of 4095, 0xfff, or 111111111111
  if (etTob > 0xfff) etTob = 0xfff;
 
  // Create tob word with et, eta, phi, and fpga index, bitshifted to the appropriate locations
  tobWord = (fpga << m_fpgaShift) + (eta << m_etaShift) + (phi << m_phiShift) + (rhad << m_taurhadShift) + (rcore << m_taurcoreShift) + (seed << m_seedShift) + (und << m_undShift) + (0x1 << m_seedMaxShift) + etTob + (algoVersion << m_algoVersionShift);
 
  if(algoVersion==0) {
      ATH_MSG_DEBUG("Tau tobword: " << std::bitset<32>(tobWord));
  } else {
      ATH_MSG_DEBUG("Tau BDT tobword: " << std::bitset<32>(tobWord) );
  }
 
  return tobWord;
}

◆ formTauxTOBWords()

std::vector< uint32_t > LVL1::eFEXFormTOBs::formTauxTOBWords	(	int	efexid,
		int	fpga,
		int	eta,
		int	phi,
		unsigned int	et,
		unsigned int	rhad,
		unsigned int	rcore,
		unsigned int	seed,
		unsigned int	und,
		unsigned int	ptMinTopo,
		unsigned int	algoVersion,
		unsigned int	bdtScore ) const

virtual

Definition at line 64 of file eFEXFormTOBs.cxx.

{
  std::vector<uint32_t> tobWords = {0, 0};
 
  // If ET < minimum return empty xTOB. Threshold is at TOB scale, so rescale ET before applying
  if ((et >> m_tobETshift) < ptMinTopo) return tobWords;
 
  if(algoVersion>0) {
      und = 0; // no und bit in BDT xTOBs
  }
 
  // Truncate ET at 16 bits, set to max value of 0xffff
  unsigned int etTob = (et < 0xffff ? et : 0xffff);
 
  // Calculate shelf and eFEX numbers from the efex index
  uint8_t shelf = int(efexid/12);
  uint8_t efex  = efexid%12;
 
  // Create tob word 0 with eta, phi, and fpga index, bitshifted to the appropriate locations
  tobWords[0] = (fpga << m_fpgaShift) + (eta << m_etaShift) + (phi << m_phiShift) + (rhad << m_taurhadShift) + (rcore << m_taurcoreShift) + (seed << m_seedShift) + (und << m_undShift) + (0x1 << m_seedMaxShift) + (algoVersion << m_algoVersionShift);
 
  // Create tob word 1 with et, efex and shelf indices, bitshifted to the appropriate locations
  tobWords[1] = (shelf << m_shelfShift) + (efex << m_efexShift) + etTob;
 
  if (algoVersion == 0) {
      ATH_MSG_DEBUG("Tau xtobwords: " << std::bitset<32>(tobWords[0]) << ", " << std::bitset<32>(tobWords[1]));
  } else {
      tobWords[0] += bdtScore; // put score in the LSBs of xtob word0
      ATH_MSG_DEBUG("Tau BDT xtobwords: " << std::bitset<32>(tobWords[0]) << ", " << std::bitset<32>(tobWords[1]));
  }
 
  return tobWords;
}

◆ initialize()

StatusCode LVL1::eFEXFormTOBs::initialize ( )

virtual

standard Athena-Algorithm method

Definition at line 29 of file eFEXFormTOBs.cxx.

{
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & LVL1::eFEXFormTOBs::interfaceID ( )

inlinestatic

Definition at line 27 of file eFEXFormTOBs.h.

27{ return IID_IeFEXFormTOBs; };

LVL1::IID_IeFEXFormTOBs

static const InterfaceID IID_IeFEXFormTOBs("LVL1::eFEXFormTOBs", 1, 0)

The eFEXFormTOBs class provides functions for creating TOBs for eFEX objects.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_algoVersionShift

const unsigned int LVL1::eFEXFormTOBs::m_algoVersionShift = 12

private

Definition at line 60 of file eFEXFormTOBs.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_efexShift

const unsigned int LVL1::eFEXFormTOBs::m_efexShift = 20

private

Definition at line 57 of file eFEXFormTOBs.h.

◆ m_etaShift

const unsigned int LVL1::eFEXFormTOBs::m_etaShift = 27

private

Definition at line 48 of file eFEXFormTOBs.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_fpgaShift

const unsigned int LVL1::eFEXFormTOBs::m_fpgaShift = 30

private

Definition at line 47 of file eFEXFormTOBs.h.

◆ m_phiShift

const unsigned int LVL1::eFEXFormTOBs::m_phiShift = 24

private

Definition at line 49 of file eFEXFormTOBs.h.

◆ m_retaShift

const unsigned int LVL1::eFEXFormTOBs::m_retaShift = 18

private

Definition at line 52 of file eFEXFormTOBs.h.

◆ m_rhadShift

const unsigned int LVL1::eFEXFormTOBs::m_rhadShift = 22

private

Definition at line 50 of file eFEXFormTOBs.h.

◆ m_seedMaxShift

const unsigned int LVL1::eFEXFormTOBs::m_seedMaxShift = 14

private

Definition at line 55 of file eFEXFormTOBs.h.

◆ m_seedShift

const unsigned int LVL1::eFEXFormTOBs::m_seedShift = 16

private

Definition at line 53 of file eFEXFormTOBs.h.

◆ m_shelfShift

const unsigned int LVL1::eFEXFormTOBs::m_shelfShift = 24

private

Definition at line 56 of file eFEXFormTOBs.h.

◆ m_taurcoreShift

const unsigned int LVL1::eFEXFormTOBs::m_taurcoreShift = 18

private

Definition at line 59 of file eFEXFormTOBs.h.

◆ m_taurhadShift

const unsigned int LVL1::eFEXFormTOBs::m_taurhadShift = 20

private

Definition at line 58 of file eFEXFormTOBs.h.

◆ m_tobETshift

const unsigned int LVL1::eFEXFormTOBs::m_tobETshift = 2

private

Internal data.

Definition at line 46 of file eFEXFormTOBs.h.

◆ m_undShift

const unsigned int LVL1::eFEXFormTOBs::m_undShift = 15

private

Definition at line 54 of file eFEXFormTOBs.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_wstotShift

const unsigned int LVL1::eFEXFormTOBs::m_wstotShift = 20

private

Definition at line 51 of file eFEXFormTOBs.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ eFEXFormTOBs()

◆ ~eFEXFormTOBs()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ formEmTOBWord()

◆ formEmxTOBWords()

◆ formTauTOBWord()

◆ formTauxTOBWords()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_algoVersionShift

◆ m_detStore

◆ m_efexShift

◆ m_etaShift

◆ m_evtStore

◆ m_fpgaShift

◆ m_phiShift

◆ m_retaShift

◆ m_rhadShift

◆ m_seedMaxShift

◆ m_seedShift

◆ m_shelfShift

◆ m_taurcoreShift

◆ m_taurhadShift

◆ m_tobETshift

◆ m_undShift

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_wstotShift