An AlgTool class to help converting LAr raw data objects to/from ByteStream. More...

#include <LArRawDataContByteStreamTool.h>

Inheritance diagram for LArRawDataContByteStreamTool:

Collaboration diagram for LArRawDataContByteStreamTool:

Public Types
using	FEA_t = FullEventAssembler<RodRobIdMap>

Public Member Functions
	LArRawDataContByteStreamTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor Standard AlgTool constructor.
virtual	~LArRawDataContByteStreamTool ()
	Destructor.
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
template<class COLLECTION, typename ... ARGS>
StatusCode	convert (const RawEvent re, COLLECTION digit_cont, CaloGain::CaloGain gain, ARGS &&... args) const
	Templated conversion class form Raw Event to a container.
StatusCode	WriteLArDigits (const LArDigitContainer *digit_cont, FEA_t &fea) const
	Fill channels from LArDigitContainer to a FullEvent.
StatusCode	WriteLArCalibDigits (const LArCalibDigitContainer *digit_cont, FEA_t &fea) const
	Fill channels from LArCalibDigitContainer to a FullEvent.
StatusCode	WriteLArRawChannels (const LArRawChannelContainer *CannelCont, FEA_t &fea) const
	Fill channels from LArRawChannelContainer to a FullEvent.
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 ()
	AlgTool 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
using	RobIndex_t = std::map<eformat::SubDetectorGroup, std::vector<const uint32_t*> >
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	prepareRobIndex (const RawEvent *event, RobIndex_t &robIndex) const
	Prepare ROB index before conversion.
std::unique_ptr< LArRodBlockStructure >	makeRodBlockStructure () const
	Construct a RodBlockStructure instance of the proper concrete type.
template<class COLLECTION>
bool	checkGainConsistency (const COLLECTION *coll) const
	Check that all elements in a container have the same gain.
const Hid2RESrcID &	getHid2RESrcID (const LArFebRodMapping &rodMapping) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
CxxUtils::CachedUniquePtr< Hid2RESrcID >	m_hid2re
	Contains the mapping from channel to ROD (writing only)
PublicToolHandle< LArRodDecoder >	m_decoder { this, "LArRodDecoder", "LArRodDecoder", "LArRodDecoder" }
unsigned	m_DSPRunMode
	Indicates which version of DSP code should be used for writing.
unsigned short	m_RodBlockVersion
	Minor ROD block version This is equivalent to the lower 16 bits of the version word in the ROD block header.
bool	m_initializeForWriting
	JobOption to intitialize services needed only for writing.
uint16_t	m_subDetId
double	m_nfebsigma
bool	m_includeDigits
std::string	m_DigitContName
const LArOnlineID *	m_onlineHelper = nullptr
SG::ReadCondHandleKey< CaloNoise >	m_caloNoiseKey { this, "CaloNoiseKey", "totalNoise", "" }
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_onOffIdMappingKey { this, "OnOffIdMappingKey", "LArOnOffIdMap", "LArOnOffIdMap" }
SG::ReadCondHandleKey< LArFebRodMapping >	m_febRodMappingKey { this, "FebRodMappingKey", "LArFebRodMap", "LArFebRodMap" }
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey { this, "CaloDetDescrManager", "CaloDetDescrManager", "SG Key for CaloDetDescrManager in the Condition Store" }
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

An AlgTool class to help converting LAr raw data objects to/from ByteStream.

This tool is used for reading as well as writing. It's main prupose is to find all LAr-Fragment in the full byte-stream event

Definition at line 48 of file LArRawDataContByteStreamTool.h.

Member Typedef Documentation

◆ FEA_t

using LArRawDataContByteStreamTool::FEA_t = FullEventAssembler<RodRobIdMap>

Definition at line 50 of file LArRawDataContByteStreamTool.h.

◆ RobIndex_t

using LArRawDataContByteStreamTool::RobIndex_t = std::map<eformat::SubDetectorGroup, std::vector<const uint32_t*> >

private

Definition at line 118 of file LArRawDataContByteStreamTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ LArRawDataContByteStreamTool()

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

Constructor Standard AlgTool constructor.

Definition at line 42 of file LArRawDataContByteStreamTool.cxx.

  :  AthAlgTool(type,name,parent)
{ declareInterface< LArRawDataContByteStreamTool  >( this );
  declareProperty("DSPRunMode",m_DSPRunMode=4);
  declareProperty("RodBlockVersion",m_RodBlockVersion=0);
  declareProperty("FebNoiseCut",m_nfebsigma=2);
  declareProperty("InitializeForWriting",m_initializeForWriting=false);
  declareProperty("SubDetectorId",m_subDetId=0);
  declareProperty("IncludeDigits",m_includeDigits=false);
  declareProperty("DigitsContainer",m_DigitContName="LArDigitContainer_MC_Thinned");
}

◆ ~LArRawDataContByteStreamTool()

LArRawDataContByteStreamTool::~LArRawDataContByteStreamTool ( )

virtual

Destructor.

Definition at line 55 of file LArRawDataContByteStreamTool.cxx.

55 {

56}

Member Function Documentation

◆ checkGainConsistency()

template<class COLLECTION>

bool LArRawDataContByteStreamTool::checkGainConsistency ( const COLLECTION * coll ) const

private

Check that all elements in a container have the same gain.

Parameters

coll	Pointer to input container (template)

Returns: false if an incosistency is detected

◆ convert()

template<class COLLECTION, typename ... ARGS>

StatusCode LArRawDataContByteStreamTool::convert	(	const RawEvent *	re,
		COLLECTION *	digit_cont,
		CaloGain::CaloGain	gain,
		ARGS &&...	args ) const

Templated conversion class form Raw Event to a container.

Parameters

RawEvent	Full event in ByteStream format as defined in `ByteStreamData/RawEvent.h`
COLLECTION	Template for the raw data container. Can be the containers of LArRawChannel, LArDigit, LArCalibDigit, LArFebHeader or LArAccumulatedCalibDigit or LArAccumulatedDigit
gain	For fixed-gain mode (e.g. calibration digits), indicates which gain should be read

Returns: Gaudi StatusCode

Iterates though all levels of the Atlas ByteStream format (aka eformat) to get all ROD fragments belonging to LAr. Methods from LArRodDecoder are used to deal with the individual ROD fragments.

◆ 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

◆ finalize()

StatusCode LArRawDataContByteStreamTool::finalize ( )

overridevirtual

Definition at line 92 of file LArRawDataContByteStreamTool.cxx.

{
  ATH_CHECK( AthAlgTool::finalize() );
  return StatusCode::SUCCESS;
}

◆ getHid2RESrcID()

const Hid2RESrcID & LArRawDataContByteStreamTool::getHid2RESrcID ( const LArFebRodMapping & rodMapping ) const

private

Definition at line 451 of file LArRawDataContByteStreamTool.cxx.

{
  if (!m_hid2re) {
    auto hid2re = std::make_unique<Hid2RESrcID>();
    if (hid2re->initialize (rodMapping).isFailure()) {
      std::abort();
    }
    m_hid2re.set (std::move (hid2re));
  }
  return *m_hid2re.get();
}

◆ initialize()

StatusCode LArRawDataContByteStreamTool::initialize ( )

overridevirtual

Definition at line 60 of file LArRawDataContByteStreamTool.cxx.

{
  ATH_CHECK( AthAlgTool::initialize() );
  ATH_MSG_DEBUG ( "Initializing LArRawDataContByteStream" );
 
  ATH_CHECK( m_decoder.retrieve() );
 
  if (m_initializeForWriting) {
   if (m_DSPRunMode == 0) {
     // Obsolete mode 
     ATH_MSG_ERROR ( "LArRodBlockStructure type 0 is obsolete and can't be used any more." );
     return StatusCode::FAILURE;
   }
 
   ATH_CHECK( detStore()->retrieve (m_onlineHelper, "LArOnlineID") );
 
   ATH_MSG_INFO ( "Initialization done for reading and writing" );
 }
  else {
    ATH_MSG_INFO ( "Initialization done for reading only" );
  }
 
  ATH_CHECK( m_caloNoiseKey.initialize (m_initializeForWriting) );
  ATH_CHECK( m_onOffIdMappingKey.initialize (m_initializeForWriting) );
  ATH_CHECK( m_febRodMappingKey.initialize (m_initializeForWriting) );
  ATH_CHECK( m_caloMgrKey.initialize (m_initializeForWriting) );
 
  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 & LArRawDataContByteStreamTool::interfaceID ( )

static

AlgTool InterfaceID.

Definition at line 37 of file LArRawDataContByteStreamTool.cxx.

38{ return IID_ILArRawDataContByteStreamTool; }

IID_ILArRawDataContByteStreamTool

static const InterfaceID IID_ILArRawDataContByteStreamTool("LArRawDataContByteStreamTool", 1, 0)

◆ makeRodBlockStructure()

std::unique_ptr< LArRodBlockStructure > LArRawDataContByteStreamTool::makeRodBlockStructure ( ) const

private

Construct a RodBlockStructure instance of the proper concrete type.

Definition at line 408 of file LArRawDataContByteStreamTool.cxx.

{
  switch(m_DSPRunMode) {
  case 0:  // Obsolete; shouldn't get here.
    std::abort();
 
  case 2:  //Transparent mode, DSP just copies FEB-data                                            
    ATH_MSG_DEBUG ( "Set Rod Block Type to LArRodBlockTransparent (#2)" );
    return std::make_unique<LArRodBlockTransparentV0<LArRodBlockHeaderTransparentV0> >(this->msgSvc().get());
    break;
 
  case 7: //Calibration mode
    ATH_MSG_DEBUG ( "Set Rod Block Type to LArRodBlockCalibration (#7)" );
    return std::make_unique<LArRodBlockCalibrationV0<LArRodBlockHeaderCalibrationV0> >(this->msgSvc().get());
    break;
 
  case 4: //Physics assembly mode
    if ( m_RodBlockVersion == 10 ){
      ATH_MSG_DEBUG ( "Set Rod Block Type to LArRodBlockPhysics (#5)" );
      return std::make_unique<LArRodBlockPhysicsV5>(this->msgSvc().get());
    }
    else if ( m_RodBlockVersion == 12 ){
      ATH_MSG_DEBUG ( "Set Rod Block Type to LArRodBlockPhysics (#6)" );
      return std::make_unique<LArRodBlockPhysicsV6>(this->msgSvc().get());
    }
    else {
      ATH_MSG_DEBUG ( "Set Rod Block Type to LArRodBlockPhysics (#4)" );
      return std::make_unique<LArRodBlockPhysicsV0>(this->msgSvc().get());
    }
    break;
 
  case 5: //Physics assembly mode
    ATH_MSG_DEBUG ( "Set Rod Block Type to LArRodBlockPhysics (#5)" );
    return std::make_unique<LArRodBlockPhysicsV3>(this->msgSvc().get());
 
  default:
    ATH_MSG_WARNING ( "DSP runmode " << m_DSPRunMode << " is unknown. Using physics assembly mode (#4) by default" );
    return std::make_unique<LArRodBlockPhysicsV0>(this->msgSvc().get());
  }
}

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

◆ prepareRobIndex()

StatusCode LArRawDataContByteStreamTool::prepareRobIndex	(	const RawEvent *	event,
		RobIndex_t &	robIndex ) const

private

Prepare ROB index before conversion.

Definition at line 376 of file LArRawDataContByteStreamTool.cxx.

{
  // This `optimization' leads to disaster if there ever happen to be
  // two adjacent events with identical L1 IDs --- in that case,
  // we'd be using the dangling ROB pointers from the last event.
  // We should generally come through here only once per event anyway.
  ATH_MSG_DEBUG( "Converting event (from ByteStream)" );
 
  if (!re) {
    ATH_MSG_ERROR ( "RawEvent passed to 'convert'-function is a null pointer!" );
    return StatusCode::FAILURE;
  }
 
  if (!m_decoder->check_valid (re, msg())) return StatusCode::FAILURE;
 
  ATH_MSG_VERBOSE ( "Full Event:" );
  ATH_MSG_VERBOSE ( MSG::hex << "Full source ID: " << re->source_id() << MSG::dec );
  ATH_MSG_VERBOSE ("Fragment size in words: " << re->fragment_size_word() );
 
  // Need to clear up or it will accumulate
  robIndex.clear();
  eformat::helper::build_toc(*re, robIndex );
  if ( robIndex.empty() ) { // This is a problem
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

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

◆ WriteLArCalibDigits()

StatusCode LArRawDataContByteStreamTool::WriteLArCalibDigits	(	const LArCalibDigitContainer *	digit_cont,
		FEA_t &	fea ) const

Fill channels from LArCalibDigitContainer to a FullEvent.

Parameters

digit_cont	Pointer to LArCalibDigitContainer (input)
fea	Pointer to FullEventAssember (output)

Returns: Gaudi StatusCode

Definition at line 197 of file LArRawDataContByteStreamTool.cxx.

{
 if (!m_initializeForWriting) {
   ATH_MSG_ERROR ( "Tool not setup for writing! Use property " 
                   << name()<<".InitializeForWriting" );
   return StatusCode::FAILURE;
 }
 ATH_MSG_DEBUG ( "Writing LArCalibDigitContainer to ByteStream" );
 if (!digitCont) {
   ATH_MSG_DEBUG ( "Null pointer passed to WriteLArCalibDigit routine!" );
   return StatusCode::FAILURE;
 }
 
 std::unique_ptr<LArRodBlockStructure> blstruct = makeRodBlockStructure();
 
 if (!blstruct->canSetCalibration()|| !blstruct->canSetRawDataFixed()) {
   ATH_MSG_DEBUG ( "This instance of LArRodBlockStructure can't hold LArCalibDigits!" );
   return StatusCode::FAILURE;
 }
 fea.setRodMinorVersion(m_RodBlockVersion);
 fea.setDetEvtType(m_DSPRunMode);
 ATH_MSG_DEBUG ( "Setting Detector Event Type to " << m_DSPRunMode 
                 << "and Minor Version Number to " << m_RodBlockVersion );
 FEA_t::RODDATA*  theROD;
 LArCalibDigitContainer::const_iterator it_b=digitCont->begin();
 LArCalibDigitContainer::const_iterator it_e=digitCont->end();
 if (it_b==it_e) {
   ATH_MSG_WARNING ( "Attempt to persistify a empty LArDigitContainer to ByteStream" );
   return StatusCode::SUCCESS;
 }
 if (!checkGainConsistency(digitCont)) {
   ATH_MSG_ERROR ( "Inconsistent gain in LArCalibDigitContainer" );
   return StatusCode::FAILURE;
 }
 
 const EventContext& ctx = Gaudi::Hive::currentContext();
 SG::ReadCondHandle<LArOnOffIdMapping> onOffMapping (m_onOffIdMappingKey, ctx);
 SG::ReadCondHandle<LArFebRodMapping> febRodMapping (m_febRodMappingKey, ctx);
 SG::ReadCondHandle<CaloDetDescrManager> caloMgr (m_caloMgrKey, ctx);
 const Hid2RESrcID& hid2re = getHid2RESrcID (**febRodMapping);
 
 std::map<uint32_t, LArRodEncoder> mapEncoder; 
 
 auto getEncoder = [&] (uint32_t reid) -> LArRodEncoder&
                   { return mapEncoder.try_emplace (reid,
                                                    *m_onlineHelper,
                                                    **caloMgr,
                                                    **onOffMapping,
                                                    blstruct.get()).first->second; };
 
 unsigned n=0;
 int fixgain=(*it_b)->gain();
 
 // Sorting Channels by ROD
 for(; it_b!=it_e; ++it_b){
   const LArCalibDigit* digit = *it_b; 
   HWIdentifier  chid = digit->hardwareID() ; 
   uint32_t reid      = hid2re.getRodID( **febRodMapping, chid );
   getEncoder(reid).add (digit, fixgain);
   n++;
 } 
 
 ATH_MSG_VERBOSE(" number of channels in the LArCalibDigitContainer for gain " 
                 << fixgain << ": "<<n );
 
 SG::ReadCondHandle<CaloNoise> noise (m_caloNoiseKey, ctx);
 
 // Now loop over map and fill all ROD Data Blocks
 std::map<uint32_t,LArRodEncoder>::iterator it  =mapEncoder.begin(); 
 std::map<uint32_t,LArRodEncoder>::iterator it_end=mapEncoder.end();
 // LArRodEncoder has collected all the channels, now can fill the
 // ROD block data.
 for(; it!=it_end;++it) {
   theROD  = fea.getRodData( (*it).first ); 
   ((*it).second).fillROD( *theROD,msg(), **noise, m_nfebsigma ) ; 
 } 
 ATH_MSG_DEBUG ( "Filled " << mapEncoder.size() << " Rod Blocks" );
 return StatusCode::SUCCESS;
}

◆ WriteLArDigits()

StatusCode LArRawDataContByteStreamTool::WriteLArDigits	(	const LArDigitContainer *	digit_cont,
		FEA_t &	fea ) const

Fill channels from LArDigitContainer to a FullEvent.

Parameters

digit_cont	Pointer to LArDigitContainer (input)
fea	Pointer to FullEventAssember (output)

Returns: Gaudi StatusCode

Definition at line 100 of file LArRawDataContByteStreamTool.cxx.

{
 if (!m_initializeForWriting) {
   ATH_MSG_ERROR ( "Tool not setup for writing! Use property " 
                   << name()<<".InitializeForWriting" );
   return StatusCode::FAILURE;
 }
 ATH_MSG_DEBUG ( "Writing LArDigitContainer to ByteStream" );
 if (!digitCont) {
   ATH_MSG_ERROR ( "Null pointer passed to WriteLArDigit routine!" );
   return StatusCode::FAILURE;
 }
 
 std::unique_ptr<LArRodBlockStructure> blstruct = makeRodBlockStructure();
 
 if (!blstruct->canSetRawData() && !blstruct->canSetRawDataFixed()) {
   ATH_MSG_DEBUG ( "This instance of LArRodBlockStructure can't hold LArDigits!" );
   return StatusCode::FAILURE;
 }
 fea.setRodMinorVersion(m_RodBlockVersion);
 fea.setDetEvtType(m_DSPRunMode);
 ATH_MSG_DEBUG ( "Setting Detector Event Type to " << m_DSPRunMode 
                 << " and Minor Version Number to " << m_RodBlockVersion );
 FEA_t::RODDATA*  theROD;
 LArDigitContainer::const_iterator it_b=digitCont->begin();
 LArDigitContainer::const_iterator it_e=digitCont->end();
 if (it_b==it_e) {
   ATH_MSG_WARNING ( "Attempt to persistify an empty LArDigitContainer to ByteStream" );
   return StatusCode::SUCCESS;
 }
 
 const EventContext& ctx = Gaudi::Hive::currentContext();
 SG::ReadCondHandle<LArOnOffIdMapping> onOffMapping (m_onOffIdMappingKey, ctx);
 SG::ReadCondHandle<LArFebRodMapping> febRodMapping (m_febRodMappingKey, ctx);
 SG::ReadCondHandle<CaloDetDescrManager> caloMgr (m_caloMgrKey, ctx);
 const Hid2RESrcID& hid2re = getHid2RESrcID (**febRodMapping);
 
 std::map<uint32_t, LArRodEncoder> mapEncoder; 
 
 auto getEncoder = [&] (uint32_t reid) -> LArRodEncoder&
                   { return mapEncoder.try_emplace (reid,
                                                    *m_onlineHelper,
                                                    **caloMgr,
                                                    **onOffMapping,
                                                    blstruct.get()).first->second; };
 
 unsigned n=0;
 if (blstruct->canSetRawDataFixed() && checkGainConsistency(digitCont))
   {//Set fixed gain raw data
     int fixgain=(*it_b)->gain();
     ATH_MSG_DEBUG(" number of Digits in LArDigitContainer for gain " << fixgain << ": " 
                   << digitCont->size() );
     // Sorting Channels by ROD
     for(; it_b!=it_e; ++it_b){
       const LArDigit* digit = *it_b; 
       HWIdentifier  chid = digit->hardwareID() ; 
       uint32_t reid      = hid2re.getRodID( **febRodMapping, chid );
       getEncoder(reid).add (digit, fixgain);
       n++;
     }  
     ATH_MSG_VERBOSE(" number of channels in the LArDigitContainer for gain " 
                     << fixgain << ": "<<n );
   } // end if
 else 
   if (blstruct->canSetRawData()) { //Set free gain raw data
     ATH_MSG_DEBUG(" number of channels in LArDigit container: "<< digitCont->size() );
 
      // Sorting Channels by ROD
      for(; it_b!=it_e; ++it_b){
    const LArDigit* digit = *it_b; 
    HWIdentifier  chid = digit->hardwareID() ; 
    uint32_t reid      = hid2re.getRodID( **febRodMapping, chid ); 
    getEncoder(reid).add (digit);
    n++;
      }  
      ATH_MSG_VERBOSE(" number of channels added to framgent: "<<n );
     }//  end else-if(can set Raw data)
 
 SG::ReadCondHandle<CaloNoise> noise (m_caloNoiseKey, ctx);
 
 // Now loop over map and fill all ROD Data Blocks
 std::map<uint32_t,LArRodEncoder>::iterator it  =mapEncoder.begin(); 
 std::map<uint32_t,LArRodEncoder>::iterator it_end=mapEncoder.end();
 // LArRodEncoder has collected all the channels, now can fill the
 // ROD block data.
 for(; it!=it_end;++it) {
   theROD  = fea.getRodData( (*it).first );
   ((*it).second).fillROD(*theROD,msg(), **noise, m_nfebsigma ) ; 
 } 
 ATH_MSG_DEBUG ( "Filled " << mapEncoder.size() << " Rod Blocks" );
 return StatusCode::SUCCESS;
}

◆ WriteLArRawChannels()

StatusCode LArRawDataContByteStreamTool::WriteLArRawChannels	(	const LArRawChannelContainer *	CannelCont,
		FEA_t &	fea ) const

Fill channels from LArRawChannelContainer to a FullEvent.

Parameters

digit_cont	Pointer to LArRawChannelContainer (input)
fea	Pointer to FullEventAssember (output)

Returns: Gaudi StatusCode

Definition at line 280 of file LArRawDataContByteStreamTool.cxx.

{
 if (!m_initializeForWriting) {
   ATH_MSG_ERROR ( "Tool not setup for writing! Use property " 
                   << name()<<".InitializeForWriting" );
   return StatusCode::FAILURE;
 }
 if (!channelCont) {
   ATH_MSG_DEBUG ( "Null pointer passed to WriteLArCalibDigit routine!" );
  return StatusCode::FAILURE;
 }
 
 std::unique_ptr<LArRodBlockStructure> blstruct = makeRodBlockStructure();
 
 if (!blstruct->canSetEnergy()) {
   ATH_MSG_DEBUG ( "This instance of LArRodBlockStructure can't hold LArRawChannels!" );
    return StatusCode::FAILURE;
 }
 FEA_t::RODDATA*  theROD;
 fea.setRodMinorVersion(m_RodBlockVersion);
 fea.setDetEvtType(m_DSPRunMode);
 ATH_MSG_DEBUG ( "Setting Detector Event Type to " << m_DSPRunMode 
                 << "and Minor Version Number to " << m_RodBlockVersion );
 LArRawChannelContainer::const_iterator it = channelCont->begin(); 
 LArRawChannelContainer::const_iterator it_e= channelCont->end(); 
 if ( it==it_e) {
   ATH_MSG_WARNING ( "Attempt to persistify a empty LArDigitContainer to ByteStream" );
   return StatusCode::SUCCESS;
 }
 
 const EventContext& ctx = Gaudi::Hive::currentContext();
 SG::ReadCondHandle<LArOnOffIdMapping> onOffMapping (m_onOffIdMappingKey, ctx);
 SG::ReadCondHandle<LArFebRodMapping> febRodMapping (m_febRodMappingKey, ctx);
 SG::ReadCondHandle<CaloDetDescrManager> caloMgr (m_caloMgrKey, ctx);
 const Hid2RESrcID& hid2re = getHid2RESrcID (**febRodMapping);
 
 std::map<uint32_t, LArRodEncoder> mapEncoder; 
 
 auto getEncoder = [&] (uint32_t reid) -> LArRodEncoder&
                   { return mapEncoder.try_emplace (reid,
                                                    *m_onlineHelper,
                                                    **caloMgr,
                                                    **onOffMapping,
                                                    blstruct.get()).first->second; };
 
 ATH_MSG_DEBUG(" number of LArRawChannel container "<< channelCont->size() );
 for(; it!=it_e; ++it){
     const LArRawChannel& rawChan = *it; 
     HWIdentifier  chid = rawChan.channelID() ; 
     uint32_t reid      = hid2re.getRodID( **febRodMapping, chid ); 
 
     getEncoder(reid).add (&rawChan);
   } 
   // I may want to also include the digits
   if ( m_includeDigits ) {
        const LArDigitContainer* digitCont = nullptr;
    if ( evtStore()->retrieve(digitCont,m_DigitContName).isFailure() ){
          ATH_MSG_ERROR ( "Digits required but not really found" );
    } else {
      if ( blstruct->canIncludeRawData() ){
       LArDigitContainer::const_iterator it_b=digitCont->begin();
       LArDigitContainer::const_iterator it_e=digitCont->end();
       if (it_b==it_e) {
             ATH_MSG_WARNING ( "Attempt to persistify a empty LArDigitContainer to ByteStream" );
       }
       for(; it_b!=it_e; ++it_b){
        const LArDigit* digit = *it_b;
        HWIdentifier  chid = digit->hardwareID() ;
        uint32_t reid      = hid2re.getRodID( **febRodMapping, chid );
        // Lets use anygain for the moment
        getEncoder(reid).add (digit);
           }
      } // End of check whether format allows to include RawData
    } // Finish checking for Digit container in SG
   } // End of check for digits inclusion
 
 SG::ReadCondHandle<CaloNoise> noise (m_caloNoiseKey, ctx);
      
 // Now loop over map and fill all ROD Data Blocks
 std::map<uint32_t,LArRodEncoder>::iterator it_m  =mapEncoder.begin(); 
 std::map<uint32_t,LArRodEncoder>::iterator it_m_e=mapEncoder.end();
 // LArRodEncoder has collected all the channels, now can fill the
 // ROD block data.
 for(; it_m!=it_m_e;++it_m) {
   theROD  = fea.getRodData( (*it_m).first ); 
   ((*it_m).second).fillROD( *theROD,msg(), **noise, m_nfebsigma ) ; 
   // delete ((*it_m).second);
   // ((*it_m).second)=NULL;
 } 
 ATH_MSG_DEBUG ( "Filled " << mapEncoder.size() << " Rod Blocks" );
 return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> LArRawDataContByteStreamTool::m_caloMgrKey { this, "CaloDetDescrManager", "CaloDetDescrManager", "SG Key for CaloDetDescrManager in the Condition Store" }

private

Definition at line 173 of file LArRawDataContByteStreamTool.h.

174{ this, "CaloDetDescrManager", "CaloDetDescrManager", "SG Key for CaloDetDescrManager in the Condition Store" };

◆ m_caloNoiseKey

SG::ReadCondHandleKey<CaloNoise> LArRawDataContByteStreamTool::m_caloNoiseKey { this, "CaloNoiseKey", "totalNoise", "" }

private

Definition at line 164 of file LArRawDataContByteStreamTool.h.

165{ this, "CaloNoiseKey", "totalNoise", "" };

◆ m_decoder

PublicToolHandle<LArRodDecoder> LArRawDataContByteStreamTool::m_decoder { this, "LArRodDecoder", "LArRodDecoder", "LArRodDecoder" }

private

Definition at line 137 of file LArRawDataContByteStreamTool.h.

138{ this, "LArRodDecoder", "LArRodDecoder", "LArRodDecoder" };

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

std::string LArRawDataContByteStreamTool::m_DigitContName

private

Definition at line 160 of file LArRawDataContByteStreamTool.h.

◆ m_DSPRunMode

unsigned LArRawDataContByteStreamTool::m_DSPRunMode

private

Indicates which version of DSP code should be used for writing.

This is equivalent to the DetectorEventType word in the ROD block header. Only for writing.

Definition at line 144 of file LArRawDataContByteStreamTool.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_febRodMappingKey

SG::ReadCondHandleKey<LArFebRodMapping> LArRawDataContByteStreamTool::m_febRodMappingKey { this, "FebRodMappingKey", "LArFebRodMap", "LArFebRodMap" }

private

Definition at line 170 of file LArRawDataContByteStreamTool.h.

171{ this, "FebRodMappingKey", "LArFebRodMap", "LArFebRodMap" };

◆ m_hid2re

CxxUtils::CachedUniquePtr<Hid2RESrcID> LArRawDataContByteStreamTool::m_hid2re

private

Contains the mapping from channel to ROD (writing only)

Definition at line 136 of file LArRawDataContByteStreamTool.h.

◆ m_includeDigits

bool LArRawDataContByteStreamTool::m_includeDigits

private

Definition at line 158 of file LArRawDataContByteStreamTool.h.

◆ m_initializeForWriting

bool LArRawDataContByteStreamTool::m_initializeForWriting

private

JobOption to intitialize services needed only for writing.

Definition at line 154 of file LArRawDataContByteStreamTool.h.

◆ m_nfebsigma

double LArRawDataContByteStreamTool::m_nfebsigma

private

Definition at line 156 of file LArRawDataContByteStreamTool.h.

◆ m_onlineHelper

const LArOnlineID* LArRawDataContByteStreamTool::m_onlineHelper = nullptr

private

Definition at line 162 of file LArRawDataContByteStreamTool.h.

◆ m_onOffIdMappingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> LArRawDataContByteStreamTool::m_onOffIdMappingKey { this, "OnOffIdMappingKey", "LArOnOffIdMap", "LArOnOffIdMap" }

private

Definition at line 167 of file LArRawDataContByteStreamTool.h.

168{ this, "OnOffIdMappingKey", "LArOnOffIdMap", "LArOnOffIdMap" };

◆ m_RodBlockVersion

unsigned short LArRawDataContByteStreamTool::m_RodBlockVersion

private

Minor ROD block version This is equivalent to the lower 16 bits of the version word in the ROD block header.

Only for writing.

Definition at line 150 of file LArRawDataContByteStreamTool.h.

◆ m_subDetId

uint16_t LArRawDataContByteStreamTool::m_subDetId

private

Definition at line 155 of file LArRawDataContByteStreamTool.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:

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ FEA_t

◆ RobIndex_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ LArRawDataContByteStreamTool()

◆ ~LArRawDataContByteStreamTool()

Member Function Documentation

◆ checkGainConsistency()

◆ convert()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ getHid2RESrcID()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ makeRodBlockStructure()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ prepareRobIndex()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ WriteLArCalibDigits()

◆ WriteLArDigits()

◆ WriteLArRawChannels()

Member Data Documentation

◆ m_caloMgrKey

◆ m_caloNoiseKey

◆ m_decoder

◆ m_detStore

◆ m_DigitContName

◆ m_DSPRunMode

◆ m_evtStore

◆ m_febRodMappingKey

◆ m_hid2re

◆ m_includeDigits

◆ m_initializeForWriting

◆ m_nfebsigma

◆ m_onlineHelper

◆ m_onOffIdMappingKey

◆ m_RodBlockVersion

◆ m_subDetId

◆ m_varHandleArraysDeclared

◆ m_vhka