#include <LArCellMuxAlg.h>

Inheritance diagram for GlobalSim::LArCellMuxAlg:

Collaboration diagram for GlobalSim::LArCellMuxAlg:

Public Types
using	Feb2BitsetMap = std::map< std::string, std::bitset< FEB2_BITSTREAM_SIZE > >

Public Member Functions
virtual StatusCode	initialize () override
	initialize function running before first event More...

virtual StatusCode	execute (const EventContext &) const override
	execute function running for every event More...

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

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

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Attributes
static constexpr std::size_t	FEB2_BITSTREAM_SIZE = 576

static constexpr std::size_t	BITWIDTH_2SIGMAMASK = 128

static constexpr std::size_t	BITWIDTH_MUX_INPUT = 32

static constexpr std::size_t	BITWIDTH_MUX_OUTPUT = 64

static constexpr std::size_t	N_WORDS_MUX_HEADER = 2

static constexpr std::size_t	N_WORDS_MUX_FOOTER = 7

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	writeMuxInputBitstream (Feb2BitsetMap &feb2Bitsets, const xAOD::EventInfo &eventInfo, const GlobalSim::GlobalLArCellContainer &gblLArCells) const
	Function that compiles the LASP to MUX bitstream and writes it to file. More...

StatusCode	writeMuxOutputBitstream (const Feb2BitsetMap &feb2Bitsets, const xAOD::EventInfo &eventInfo, const GlobalSim::GlobalLArCellContainer &gblLArCells) const
	Function that compiles the MUX to GEP bitstream and writes it to file. More...

std::bitset< FEB2_BITSTREAM_SIZE >	assembleBitsetForFeb2 (const std::vector< GlobalSim::GlobalLArCell * > &cells, std::size_t maxCells, bool inOverflow, bool inError, uint32_t bcid) const
	Function which compiles the bitset for one particular FEB2. More...

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

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Static Private Member Functions
template<std::size_t N, typename T >
static std::size_t	appendBits (std::bitset< N > &target, const T &src, std::size_t pos)
	Helper function to append a bitset or vector of bools at a specific position in another bitset. More...

Private Attributes
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EventInfo", "EventInfo", "Key for the EventInfo container"}
	Key for the EventInfo object. More...

SG::ReadHandleKey< GlobalSim::GlobalLArCellContainer >	m_gblLArCellContainerKey {this, "GlobalLArCellsKey", "GlobalLArCells", "Key for the output container of the LAr cells sent to Global"}
	Key to the GlobalLArCellContainer. More...

Gaudi::Property< bool >	m_writeMuxInputBitstreamToFile {this, "WriteMuxInputBitstreamToFile", true, "Flag to enable the writing of MUX input bitstreams to file"}
	Flag to enable writing of MUX input bitstreams (FEB2/LASP -> MUX) to file. More...

Gaudi::Property< bool >	m_writeMuxOutputBitstreamToFile {this, "WriteMuxOutputBitstreamToFile", true, "Flag to enable the writing of MUX output bitstreams to file"}
	Flag to enable writing ofMUX output bitstreams (MUX -> GEP) to file. More...

DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 27 of file LArCellMuxAlg.h.

Member Typedef Documentation

◆ Feb2BitsetMap

using GlobalSim::LArCellMuxAlg::Feb2BitsetMap = std::map<std::string, std::bitset<FEB2_BITSTREAM_SIZE> >

Definition at line 40 of file LArCellMuxAlg.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ appendBits()

template<std::size_t N, typename T >

std::size_t GlobalSim::LArCellMuxAlg::appendBits	(	std::bitset< N > &	target,
		const T &	src,
		std::size_t	pos
	)

staticprivate

Helper function to append a bitset or vector of bools at a specific position in another bitset.

Definition at line 273 of file LArCellMuxAlg.cxx.

                                                                                                                           {
       for (std::size_t i = 0; i < src.size(); ++i, ++pos)
           if (src[i]) target.set(pos);
       return pos;
   }

◆ assembleBitsetForFeb2()

std::bitset< LArCellMuxAlg::FEB2_BITSTREAM_SIZE > GlobalSim::LArCellMuxAlg::assembleBitsetForFeb2	(	const std::vector< GlobalSim::GlobalLArCell * > &	cells,
		std::size_t	maxCells,
		bool	inOverflow,
		bool	inError,
		uint32_t	bcid
	)		const

private

Function which compiles the bitset for one particular FEB2.

Definition at line 110 of file LArCellMuxAlg.cxx.

                                                                                                                                                                                                            {
  
       // Sort cells based on channel number
       std::vector<const GlobalSim::GlobalLArCell*> sortedCells(cells.begin(), cells.end());
       std::sort(sortedCells.begin(), sortedCells.end(), [](const auto* a, const auto* b) {
           return a->getChannel() < b->getChannel();
       });
  
       // Declare bitsets for 2sigma and 4sigma mask, as well as energies
       const std::size_t bitwidth_4SigmaMask = maxCells;
       const std::size_t bitwidth_energyBlock = FEB2_BITSTREAM_SIZE - BITWIDTH_2SIGMAMASK - bitwidth_4SigmaMask - 2 - 8;
  
       std::vector<bool> mask_twoSigma(BITWIDTH_2SIGMAMASK, false);
       std::vector<bool> mask_fourSigma(bitwidth_4SigmaMask, false);
       std::vector<bool> energyBits(bitwidth_energyBlock, false);
  
       std::size_t bitPosEnergy = 0;
  
       for (std::size_t i = 0; i < sortedCells.size(); ++i) {
  
           const auto* cell = sortedCells[i];
  
           // 2sigma mask by channel
           mask_twoSigma[cell->getChannel()] = true;
  
           // 4sigma mask by order of 2sigma cells
           mask_fourSigma[i] = (cell->getSigma() >= 4.0);
  
           // Energy bits
           const boost::dynamic_bitset<>& enBits = cell->getEnergyBitstring();
           for (std::size_t j = 0; j < enBits.size() && bitPosEnergy < bitwidth_energyBlock; ++j, ++bitPosEnergy) {
               energyBits[bitPosEnergy]= enBits[j];
           }
       }
  
       // 8b bunch crossing number
       std::bitset<8> bitsBCN(bcid & 0xFF);
  
       // Assemble final bitstream
       std::bitset<FEB2_BITSTREAM_SIZE> bitstream;
       std::size_t pos = 0;
  
       pos = appendBits(bitstream, mask_twoSigma, pos);
       pos = appendBits(bitstream, mask_fourSigma, pos);
  
       if (inOverflow) bitstream.set(pos);
       ++pos;
       if (inError) bitstream.set(pos);
       ++pos;
  
       pos = appendBits(bitstream, energyBits, pos);
       pos = appendBits(bitstream, bitsBCN, pos);
  
       return bitstream;
   }

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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());
  
   }

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode GlobalSim::LArCellMuxAlg::execute ( const EventContext & ctx ) const

overridevirtual

execute function running for every event

Definition at line 34 of file LArCellMuxAlg.cxx.

                                                                  {
  
     ATH_MSG_DEBUG ("Executing LArCellMuxAlg algorithm");
  
     // Get EventInfo
     SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfo, ctx);
     CHECK(eventInfo.isValid());
  
     // Read in GlobalLArCellContainer
     auto h_gblLArCells = SG::makeHandle(m_gblLArCellContainerKey, ctx);
     CHECK(h_gblLArCells.isValid());
     const auto & gblLArCells = *h_gblLArCells;
  
     ATH_MSG_DEBUG("Reading " << std::to_string(h_gblLArCells->size()) << " cells in input GlobalLArCellContainer");
  
     Feb2BitsetMap feb2Bitsets;
  
     // Compile and write the input bitstreams which are sent from LASP to MUX
     CHECK(writeMuxInputBitstream(feb2Bitsets, *eventInfo, gblLArCells));
  
     // Compile and write the output bitstreams which are sent from MUX to GEP
     CHECK(writeMuxOutputBitstream(feb2Bitsets, *eventInfo, gblLArCells));
  
     return StatusCode::SUCCESS;
   }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return BaseAlg::extraOutputDeps();
 }

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                            {
     return execState( ctx ).filterPassed();
   }

◆ initialize()

StatusCode GlobalSim::LArCellMuxAlg::initialize ( )

overridevirtual

initialize function running before first event

Definition at line 22 of file LArCellMuxAlg.cxx.

                                        {
     ATH_MSG_INFO ("Initializing " << name());
  
     CHECK(m_eventInfo.initialize());
     CHECK(m_gblLArCellContainerKey.initialize());
  
     return StatusCode::SUCCESS;
   }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

◆ isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

 {
   // Reentrant algorithms are clonable.
   return true;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                             {
     execState( ctx ).setFilterPassed( state );
   }

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

 {
   return BaseAlg::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                                {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }      
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;  
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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);
       }
     }
   }

◆ writeMuxInputBitstream()

StatusCode GlobalSim::LArCellMuxAlg::writeMuxInputBitstream	(	Feb2BitsetMap &	feb2Bitsets,
		const xAOD::EventInfo &	eventInfo,
		const GlobalSim::GlobalLArCellContainer &	gblLArCells
	)		const

private

Function that compiles the LASP to MUX bitstream and writes it to file.

Definition at line 64 of file LArCellMuxAlg.cxx.

                                                                                                              {
     
     std::ofstream out;
     if (m_writeMuxInputBitstreamToFile) {
         std::string filename = std::format("{}_MuxInput_{}_{}.dat", name(), eventInfo.runNumber(), eventInfo.eventNumber());
         out.open(filename);
         if (!out) {
             ATH_MSG_ERROR("Failed to open file: " << filename);
             return StatusCode::FAILURE;
         }
     }
  
     for (const auto& feb2Key : gblLArCells.getFeb2Keys()) {
  
         const std::vector<GlobalLArCell*>& cells = gblLArCells.getCellsForFeb2(feb2Key);
         std::bitset<FEB2_BITSTREAM_SIZE> input_bitstream = assembleBitsetForFeb2(cells, 
             gblLArCells.getMaxCellsPerFeb2(), 
             gblLArCells.feb2InOverflow(feb2Key), 
             gblLArCells.feb2InError(feb2Key), 
             eventInfo.bcid());
  
         feb2Bitsets[feb2Key] = input_bitstream;
  
         if (m_writeMuxInputBitstreamToFile) {
             out << "====== " << feb2Key << " is sending to " << gblLArCells.getMuxForFeb2(feb2Key) << ":\n";
  
             for (std::size_t row = 0; row < FEB2_BITSTREAM_SIZE / BITWIDTH_MUX_INPUT; ++row) {
                 for (int col = BITWIDTH_MUX_INPUT-1; col >= 0; --col) {
                     int bitIndex = row * BITWIDTH_MUX_INPUT + col;
                     out << input_bitstream[bitIndex];
                 }
                 out << "\n";
             }
             out << "\n";
         }
     }
  
     if (m_writeMuxInputBitstreamToFile) out.close();
  
     return StatusCode::SUCCESS;
   }

◆ writeMuxOutputBitstream()

StatusCode GlobalSim::LArCellMuxAlg::writeMuxOutputBitstream	(	const Feb2BitsetMap &	feb2Bitsets,
		const xAOD::EventInfo &	eventInfo,
		const GlobalSim::GlobalLArCellContainer &	gblLArCells
	)		const

private

Function that compiles the MUX to GEP bitstream and writes it to file.

Definition at line 171 of file LArCellMuxAlg.cxx.

                                                                                                               {
  
     if (!m_writeMuxOutputBitstreamToFile) {
         return StatusCode::SUCCESS;
     }
  
     std::string filename = std::format("{}_MuxOutput_{}_{}.dat", name(), eventInfo.runNumber(), eventInfo.eventNumber());
     std::ofstream out(filename);
     if (!out) {
         ATH_MSG_ERROR("Failed to open file: " << filename);
         return StatusCode::FAILURE;
     }
     
     // Assemble the header for each MUX
     const int nBitsMarker = BITWIDTH_MUX_OUTPUT / 8;
  
     // MUX marker line has the pattern ABBA ABBA
     unsigned long long markerPattern = 
         (0xAULL << nBitsMarker*7) | 
         (0xBULL << nBitsMarker*6) | 
         (0xBULL << nBitsMarker*5) | 
         (0xAULL << nBitsMarker*4) | 
         (0xAULL << nBitsMarker*3) | 
         (0xBULL << nBitsMarker*2) | 
         (0xBULL << nBitsMarker) | 
         (0xAULL);
  
     std::bitset<BITWIDTH_MUX_OUTPUT> markerBitset(markerPattern);
  
     // 12b bunch crossing number
     std::bitset<12> bitsBCN(eventInfo.bcid() & 0xFFF);
  
     // Loop over all MUX IDs
     for (int muxID = 0; muxID < 32; ++muxID) {
  
         std::string muxKey = std::format("apl-gbl-mux-lasp-{:02}", muxID);
         out << "====== " << muxKey << " is sending to GEP:\n";
  
         std::bitset<6> bitsetMuxID(muxID);
  
         // Bitset for the entire header block
         const int bitwidthMuxHeader = BITWIDTH_MUX_OUTPUT * N_WORDS_MUX_HEADER;
         std::bitset<bitwidthMuxHeader> fullMuxHeader;
  
         // Assemble the header block
         std::size_t pos = 0;
         pos = appendBits(fullMuxHeader, markerBitset, pos);
         pos = appendBits(fullMuxHeader, bitsBCN, pos);
         pos = appendBits(fullMuxHeader, bitsetMuxID, pos);
  
         // Overflow and error bits
         if (gblLArCells.muxInOverflow(muxKey)) fullMuxHeader.set(pos);
         ++pos;
         if (gblLArCells.muxInError(muxKey)) fullMuxHeader.set(pos);
         ++pos;
  
         // Write header in lines of BITWIDTH_MUX_OUTPUT
         for (std::size_t row = 0; row < N_WORDS_MUX_HEADER; ++row) {
             for (int col = BITWIDTH_MUX_OUTPUT-1; col >= 0; --col) {
                 int bitIndex = row * BITWIDTH_MUX_OUTPUT + col;
                 out << fullMuxHeader[bitIndex];
             }
             out << "\n";
         }
  
         // Get and loop over FEB2s to write the FEB2 block
         const std::vector<std::string>& feb2s = gblLArCells.getOrderedFeb2sForMux(muxKey);
         for (const auto& feb2 : feb2s) {
  
             auto it = feb2Bitsets.find(feb2);
             if (it == feb2Bitsets.end()) {
                 ATH_MSG_ERROR("No bitset for FEB2 " << feb2);
                 return StatusCode::FAILURE;
             }
             const std::bitset<FEB2_BITSTREAM_SIZE>& feb2Bitset = it->second;
  
             for (std::size_t row = 0; row < FEB2_BITSTREAM_SIZE / BITWIDTH_MUX_OUTPUT; ++row) {
                 for (int col = BITWIDTH_MUX_OUTPUT-1; col >= 0; --col) {
                     int bitIndex = row * BITWIDTH_MUX_OUTPUT + col;
                     out << feb2Bitset[bitIndex];
                 }
                 out << "\n";
             }
         }
  
         // Close by writing the footer of the MUX (N_WORDS_MUX_FOOTER empty words)
         for (std::size_t row = 0; row < N_WORDS_MUX_FOOTER; ++row) {
             for (std::size_t col = 0; col < BITWIDTH_MUX_OUTPUT; ++col) {
                 out << '0';
             }
             out << "\n";
         }
         out << "\n";
  
     } // Loop over all MUX IDs
  
     out.close();
     return StatusCode::SUCCESS;
   }

Member Data Documentation

◆ BITWIDTH_2SIGMAMASK

constexpr std::size_t GlobalSim::LArCellMuxAlg::BITWIDTH_2SIGMAMASK = 128

staticconstexpr

Definition at line 33 of file LArCellMuxAlg.h.

◆ BITWIDTH_MUX_INPUT

constexpr std::size_t GlobalSim::LArCellMuxAlg::BITWIDTH_MUX_INPUT = 32

staticconstexpr

Definition at line 34 of file LArCellMuxAlg.h.

◆ BITWIDTH_MUX_OUTPUT

constexpr std::size_t GlobalSim::LArCellMuxAlg::BITWIDTH_MUX_OUTPUT = 64

staticconstexpr

Definition at line 35 of file LArCellMuxAlg.h.

◆ FEB2_BITSTREAM_SIZE

constexpr std::size_t GlobalSim::LArCellMuxAlg::FEB2_BITSTREAM_SIZE = 576

staticconstexpr

Definition at line 32 of file LArCellMuxAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_eventInfo

SG::ReadHandleKey<xAOD::EventInfo> GlobalSim::LArCellMuxAlg::m_eventInfo {this, "EventInfo", "EventInfo", "Key for the EventInfo container"}

private

Key for the EventInfo object.

Definition at line 60 of file LArCellMuxAlg.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

◆ m_gblLArCellContainerKey

SG::ReadHandleKey<GlobalSim::GlobalLArCellContainer> GlobalSim::LArCellMuxAlg::m_gblLArCellContainerKey {this, "GlobalLArCellsKey", "GlobalLArCells", "Key for the output container of the LAr cells sent to Global"}

private

Key to the GlobalLArCellContainer.

Definition at line 63 of file LArCellMuxAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_writeMuxInputBitstreamToFile

Gaudi::Property<bool> GlobalSim::LArCellMuxAlg::m_writeMuxInputBitstreamToFile {this, "WriteMuxInputBitstreamToFile", true, "Flag to enable the writing of MUX input bitstreams to file"}

private

Flag to enable writing of MUX input bitstreams (FEB2/LASP -> MUX) to file.

Definition at line 66 of file LArCellMuxAlg.h.

◆ m_writeMuxOutputBitstreamToFile

Gaudi::Property<bool> GlobalSim::LArCellMuxAlg::m_writeMuxOutputBitstreamToFile {this, "WriteMuxOutputBitstreamToFile", true, "Flag to enable the writing of MUX output bitstreams to file"}

private

Flag to enable writing ofMUX output bitstreams (MUX -> GEP) to file.

Definition at line 69 of file LArCellMuxAlg.h.

◆ N_WORDS_MUX_FOOTER

constexpr std::size_t GlobalSim::LArCellMuxAlg::N_WORDS_MUX_FOOTER = 7

staticconstexpr

Definition at line 37 of file LArCellMuxAlg.h.

◆ N_WORDS_MUX_HEADER

constexpr std::size_t GlobalSim::LArCellMuxAlg::N_WORDS_MUX_HEADER = 2

staticconstexpr

Definition at line 36 of file LArCellMuxAlg.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Feb2BitsetMap

◆ StoreGateSvc_t

Member Function Documentation

◆ appendBits()

◆ assembleBitsetForFeb2()

◆ cardinality()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ writeMuxInputBitstream()

◆ writeMuxOutputBitstream()

Member Data Documentation

◆ BITWIDTH_2SIGMAMASK

◆ BITWIDTH_MUX_INPUT

◆ BITWIDTH_MUX_OUTPUT

◆ FEB2_BITSTREAM_SIZE

◆ m_detStore

◆ m_eventInfo

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_gblLArCellContainerKey

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_writeMuxInputBitstreamToFile

◆ m_writeMuxOutputBitstreamToFile

◆ N_WORDS_MUX_FOOTER

◆ N_WORDS_MUX_HEADER