Provide Supercell-tower mapping Load information stored in a .csv file and provide information needed to connect the SuperCells to its corresponding tower. More...

#include <eFEXSuperCellTowerIdProvider.h>

Inheritance diagram for LVL1::eFEXSuperCellTowerIdProvider:

Collaboration diagram for LVL1::eFEXSuperCellTowerIdProvider:

Classes
struct	towerinfo
	Sturcture stores mapping information of a SuperCell. More...

Public Member Functions
	eFEXSuperCellTowerIdProvider (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor.
	~eFEXSuperCellTowerIdProvider ()
	Destructor.
virtual StatusCode	initialize () override
	initialize the tool
StatusCode	setAddress (const std::string &)
	set the address to the csv file and load
StatusCode	geteTowerIDandslot (uint64_t scid, int &eTowerID, int &slot, bool &issplit) const
	obtain ordered tower IDs in an eFEX
bool	ifhaveinputfile () const
	Check if the csv file is valid.
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
bool	hasSuperCell (uint64_t) const
	Check if the SuperCell id exists in the csv file.
StatusCode	loadcsv ()
	load the csv file
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
bool	m_hascsvfile {false}
	if the csv file is valid
std::string	m_csvaddress
	path to the csv file
std::unordered_map< uint64_t, towerinfo >	m_SuperCelltoTowerIdmap
	map to store information about SuperCells with SuperCell ID as the key.
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

Provide Supercell-tower mapping Load information stored in a .csv file and provide information needed to connect the SuperCells to its corresponding tower.

Definition at line 32 of file eFEXSuperCellTowerIdProvider.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

◆ eFEXSuperCellTowerIdProvider()

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

Constructor.

Definition at line 11 of file eFEXSuperCellTowerIdProvider.cxx.

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

◆ ~eFEXSuperCellTowerIdProvider()

LVL1::eFEXSuperCellTowerIdProvider::~eFEXSuperCellTowerIdProvider ( )

Destructor.

Definition at line 17 of file eFEXSuperCellTowerIdProvider.cxx.

18{

19}

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

◆ geteTowerIDandslot()

StatusCode LVL1::eFEXSuperCellTowerIdProvider::geteTowerIDandslot	(	uint64_t	scid,
		int &	eTowerID,
		int &	slot,
		bool &	issplit ) const

obtain ordered tower IDs in an eFEX

Parameters

scid	HEX SuperCell ID
eTowerID	variable to store the output tower ID
slot	variable to store the output slot number
issplite	variable to store if the SuperCell needs to be splited

Returns: status code

Definition at line 47 of file eFEXSuperCellTowerIdProvider.cxx.

{
  auto mapentry = m_SuperCelltoTowerIdmap.find(scid);
 
  if (mapentry != m_SuperCelltoTowerIdmap.end()) {
    towerinfo towerinfo_tem = mapentry->second;
    eTowerID = towerinfo_tem.eTowerID;
    slot = towerinfo_tem.slot;
    issplit = towerinfo_tem.isSplit;
  } else {
    // The csv file only contains valid SuperCell
    // Ingore invalid id.
    eTowerID = -1;
    slot = -1;
    issplit = false;
  }
 
  return StatusCode::SUCCESS;
}

◆ hasSuperCell()

bool LVL1::eFEXSuperCellTowerIdProvider::hasSuperCell ( uint64_t scid ) const

private

Check if the SuperCell id exists in the csv file.

Definition at line 67 of file eFEXSuperCellTowerIdProvider.cxx.

{
  auto haskey = m_SuperCelltoTowerIdmap.find(scid);
  if (haskey == m_SuperCelltoTowerIdmap.end()) {
    return false;
  }
  return true;
}

◆ ifhaveinputfile()

bool LVL1::eFEXSuperCellTowerIdProvider::ifhaveinputfile ( ) const

Check if the csv file is valid.

Definition at line 76 of file eFEXSuperCellTowerIdProvider.cxx.

                                                             {
  return m_hascsvfile;
}

◆ initialize()

StatusCode LVL1::eFEXSuperCellTowerIdProvider::initialize ( )

overridevirtual

initialize the tool

Definition at line 21 of file eFEXSuperCellTowerIdProvider.cxx.

{
  m_hascsvfile = false;
  std::string csvpath = PathResolver::find_file("sc_tower_map.csv", "DATAPATH");
  if (setAddress(csvpath) == StatusCode::FAILURE) {
    ATH_MSG_WARNING("sc_tower_map.csv missing or invalid. Swiching to hard-coded mapping.");
  };
  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::eFEXSuperCellTowerIdProvider::interfaceID ( )

inlinestatic

Definition at line 44 of file eFEXSuperCellTowerIdProvider.h.

44{ return IID_IIeFEXSuperCellTowerIdProvider; };

LVL1::IID_IIeFEXSuperCellTowerIdProvider

static const InterfaceID IID_IIeFEXSuperCellTowerIdProvider("LVL1::eFEXSuperCellTowerIdProvider", 1, 0)

◆ loadcsv()

StatusCode LVL1::eFEXSuperCellTowerIdProvider::loadcsv ( )

private

load the csv file

Definition at line 80 of file eFEXSuperCellTowerIdProvider.cxx.

{
  // read the .csv file line by line
  std::string eachline;
  std::ifstream myfile(m_csvaddress);
  if (myfile.is_open()) {
    while (std::getline(myfile, eachline)) {
 
      // ignore text after #
      std::string::size_type ipos = eachline.find("#");
      if (ipos!=std::string::npos) eachline.resize(ipos);
 
      // prevent reading lines with only white spaces
      if (std::all_of(eachline.begin(), eachline.end(), ::isspace)) {
        continue;
      }
 
      // split lines in the .csv file by comma
      std::stringstream eachline_stream(eachline);
      int each_etowerid{ -1 }, each_slot{ -1 };
      bool eachisSplit{ false };
      std::string each_scid = "";
      int i{ 0 };
      while (eachline_stream.good()) {
        i++;
        int number_in_eachline;
        std::string tem_string;
        std::getline(eachline_stream, tem_string, ',');
        // first column: tower id
        // second column: supercell id
        // third column: slot number
        // fourth column: if split energy
        if (i == 1 || i == 3 || i == 4) {
          try {
            number_in_eachline = std::stoi(tem_string);
          }
          catch (...) {
            ATH_MSG_ERROR( "Invalid input in " << m_csvaddress << ". Unable to convert " << tem_string << " to int.");
            return StatusCode::FAILURE;
          }
          if (i == 1) {
            each_etowerid = number_in_eachline;
          } else if (i == 3) {
            each_slot = number_in_eachline;
          } else {
            // check if the fourth column is a boolean or not
            if (number_in_eachline != 0 && number_in_eachline != 1) {
              ATH_MSG_ERROR("Invalid input in " << m_csvaddress << ". Unable to reader the fourth column.");
              return StatusCode::FAILURE;
            }
            eachisSplit = number_in_eachline;
          }
        }
        else if (i == 2) {
          each_scid = std::move(tem_string);
        }
        else {
          ATH_MSG_ERROR("Invalid input in " << m_csvaddress << ". Too many columns.");
          return StatusCode::FAILURE;
        }
      }
      
      // check the range of tower id
      if (each_etowerid > 601599 || each_etowerid < 100000) {
        ATH_MSG_ERROR("Invalid eTower ID in " << m_csvaddress << ".");
        return StatusCode::FAILURE;
      }
      // check the range of slot
      if (each_slot > 13 || each_slot < 0) {
        ATH_MSG_ERROR("Invalid slot number in " << m_csvaddress << ".");
        return StatusCode::FAILURE;
      }
      // The Hexadecimal SuperCell id should always start as 0x
      if (each_scid.find("0x") == std::string::npos) {
        ATH_MSG_ERROR("Invalid SuperCell ID in " << m_csvaddress << ".");
        return StatusCode::FAILURE;
      }
      towerinfo each_towerinfo;
      each_towerinfo.eTowerID = each_etowerid;
      each_towerinfo.slot = each_slot;
      each_towerinfo.isSplit = eachisSplit;
      uint64_t scid_uint64 = strtoull(each_scid.c_str(), nullptr, 16);
      try {
        m_SuperCelltoTowerIdmap[scid_uint64] = each_towerinfo;
      } catch (...) {
        ATH_MSG_ERROR("Invalid SuperCell ID in " << m_csvaddress << ".");
        return StatusCode::FAILURE;
      }
    }
    myfile.close();
  }
  else {
    ATH_MSG_ERROR("eFEXFPGATowerIdProvider: Unable to open" << m_csvaddress << ".");
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

◆ 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();
  }

◆ setAddress()

StatusCode LVL1::eFEXSuperCellTowerIdProvider::setAddress ( const std::string & inputaddress )

set the address to the csv file and load

Definition at line 31 of file eFEXSuperCellTowerIdProvider.cxx.

{
  if (inputaddress.empty()) {
    m_hascsvfile = false;
    return StatusCode::FAILURE;
  }
 
  m_hascsvfile = true;
  m_csvaddress = inputaddress;
  if ( loadcsv() == StatusCode::FAILURE) {
    m_hascsvfile = false;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

◆ 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_csvaddress

std::string LVL1::eFEXSuperCellTowerIdProvider::m_csvaddress

private

path to the csv file

Definition at line 76 of file eFEXSuperCellTowerIdProvider.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_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_hascsvfile

bool LVL1::eFEXSuperCellTowerIdProvider::m_hascsvfile {false}

private

if the csv file is valid

Definition at line 74 of file eFEXSuperCellTowerIdProvider.h.

74{false};

◆ m_SuperCelltoTowerIdmap

std::unordered_map<uint64_t, towerinfo> LVL1::eFEXSuperCellTowerIdProvider::m_SuperCelltoTowerIdmap

private

map to store information about SuperCells with SuperCell ID as the key.

Definition at line 85 of file eFEXSuperCellTowerIdProvider.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.

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

Classes

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

◆ eFEXSuperCellTowerIdProvider()

◆ ~eFEXSuperCellTowerIdProvider()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ geteTowerIDandslot()

◆ hasSuperCell()

◆ ifhaveinputfile()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ loadcsv()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setAddress()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_csvaddress

◆ m_detStore

◆ m_evtStore

◆ m_hascsvfile

◆ m_SuperCelltoTowerIdmap

◆ m_varHandleArraysDeclared

◆ m_vhka