xAODMaker::EventInfoCnvTool Class Reference

Implementation for the IEventInfoCnvTool interface. More...

#include <EventInfoCnvTool.h>

Inheritance diagram for xAODMaker::EventInfoCnvTool:

Collaboration diagram for xAODMaker::EventInfoCnvTool:

Public Member Functions
	EventInfoCnvTool (const std::string &type, const std::string &name, const IInterface *parent)
	Regular AlgTool constructor.
virtual StatusCode	initialize () override
	Function initialising the tool.
virtual StatusCode	convert (const EventInfo *aod, xAOD::EventInfo *xaod, bool pileUpInfo=false, bool copyPileUpLinks=true, const EventContext &ctx=Gaudi::Hive::currentContext()) const override
	Function that fills an existing xAOD::EventInfo object with data.
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 ()
	Gaudi interface definition.

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
SG::ReadCondHandleKey< InDet::BeamSpotData >	m_beamSpotKey { this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" }
Gaudi::Property< bool >	m_disableBeamSpot { this, "DisableBeamSpot", false, "disable beamspot" }
bool	m_beamSpotInformationAvailable {}
	Internal flag for the availability of the beam spot information.
SG::ReadCondHandleKey< LuminosityCondData >	m_lumiDataKey { this, "LumiDataKey", "", "SG key for luminosity data" }
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

Implementation for the IEventInfoCnvTool interface.

   This is a simple tool that implements the converter function
   defined in IEventInfoCnvTool.

Author

Attila Krasznahorkay Attil.nosp@m.a.Kr.nosp@m.aszna.nosp@m.hork.nosp@m.ay@ce.nosp@m.rn.c.nosp@m.h

Definition at line 42 of file EventInfoCnvTool.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

EventInfoCnvTool()

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

Regular AlgTool constructor.

Definition at line 52 of file EventInfoCnvTool.cxx.

      : AthAlgTool( type, name, parent )
   {
      // Declare the interface(s) provided by the tool:
      declareInterface< IEventInfoCnvTool >( this );
   }

Member Function Documentation

convert()

StatusCode xAODMaker::EventInfoCnvTool::convert ( const EventInfo * aod, xAOD::EventInfo * xaod, bool pileUpInfo = false, bool copyPileUpLinks = true, const EventContext & ctx = Gaudi::Hive::currentContext() ) const

overridevirtual

Function that fills an existing xAOD::EventInfo object with data.

This is the important function of the tool.

It takes the EventInfo object available in Athena, and fills an xAOD::EventInfo object with its contents.

Parameters

aod	The AOD's EventInfo object
xaod	The xAOD::EventInfo object to fill
pileUpInfo	true for pile-up EventInfo objects
copyPileUpLinks	Allows to turn the ElementLink creation on or off
ctx	Event context.

Returns

StatusCode::SUCCESS if all went fine, something else if not

Implements xAODMaker::IEventInfoCnvTool.

Definition at line 103 of file EventInfoCnvTool.cxx.

   {
 
      if( ! aod ) {
         ATH_MSG_WARNING( "Null pointer received for input!" );
         return StatusCode::SUCCESS;
      }
 
      // Copy the basic properties into the xAOD object:
      if( aod->event_ID() ) {
         xaod->setRunNumber( aod->event_ID()->run_number() );
         xaod->setEventNumber( aod->event_ID()->event_number() );
         xaod->setLumiBlock( aod->event_ID()->lumi_block() );
         xaod->setTimeStamp( aod->event_ID()->time_stamp() );
         xaod->setTimeStampNSOffset( aod->event_ID()->time_stamp_ns_offset() );
         xaod->setBCID( aod->event_ID()->bunch_crossing_id() );
         xaod->setDetectorMask( aod->event_ID()->detector_mask0(),
                                aod->event_ID()->detector_mask1() );
         xaod->setDetectorMaskExt( aod->event_ID()->detector_mask2(),
                                 aod->event_ID()->detector_mask3() );
      }
 
      // Copy the event type properties:
      std::vector< float > eventWeights;
      if( aod->event_type() ) {
         EventType::NameTagPairVec detDescrTags;
         aod->event_type()->get_detdescr_tags( detDescrTags );
         xaod->setDetDescrTags( detDescrTags );
         uint32_t eventTypeBitmask = 0;
         if( aod->event_type()->test( EventType::IS_SIMULATION ) ) {
            eventTypeBitmask |= xAOD::EventInfo::IS_SIMULATION;
         }
         if( aod->event_type()->test( EventType::IS_TESTBEAM ) ) {
            eventTypeBitmask |= xAOD::EventInfo::IS_TESTBEAM;
         }
         if( aod->event_type()->test( EventType::IS_CALIBRATION ) ) {
            eventTypeBitmask |= xAOD::EventInfo::IS_CALIBRATION;
         }
         xaod->setEventTypeBitmask( eventTypeBitmask );
         // Only add MC information for simulation files:
         if( xaod->eventType( xAOD::EventInfo::IS_SIMULATION ) ) {
            xaod->setMCChannelNumber( aod->event_type()->mc_channel_number() );
            xaod->setMCEventNumber( aod->event_type()->mc_event_number() );
            eventWeights.resize( aod->event_type()->n_mc_event_weights(), 0.0 );
            for( unsigned int i = 0; i < aod->event_type()->n_mc_event_weights();
                 ++i ) {
               eventWeights[ i ] = aod->event_type()->mc_event_weight( i );
            }
         }
      }
 
      // Copy the trigger properties into the xAOD object:
      if( aod->trigger_info() && !pileUpInfo  ) {
         xaod->setStatusElement( aod->trigger_info()->statusElement() );
         xaod->setExtendedLevel1ID( aod->trigger_info()->extendedLevel1ID() );
         xaod->setLevel1TriggerType( aod->trigger_info()->level1TriggerType() );
         std::vector< xAOD::EventInfo::StreamTag > streamTags;
         std::vector< TriggerInfo::StreamTag >::const_iterator st_itr =
            aod->trigger_info()->streamTags().begin();
         std::vector< TriggerInfo::StreamTag >::const_iterator st_end =
            aod->trigger_info()->streamTags().end();
         for( ; st_itr != st_end; ++st_itr ) {
            streamTags.emplace_back( st_itr->name(), st_itr->type(),
                                            st_itr->obeysLumiblock(),
                                            st_itr->robs(), st_itr->dets() );
         }
         xaod->setStreamTags( streamTags );
      }
 
      // Copy/calculate the pileup information:
      if( ! pileUpInfo ) {
         bool haveLumi = false;
#if !defined(XAOD_ANALYSIS) && !defined(SIMULATIONBASE) && !defined(GENERATIONBASE)
         if (!m_lumiDataKey.empty()) {
           SG::ReadCondHandle<LuminosityCondData> lumiData (m_lumiDataKey, ctx);
           if (lumiData->lbAverageLuminosity() != 0 ||
               lumiData->lbAverageInteractionsPerCrossing() != 0)
           {
             float actualMu = 0.0;
             const float muToLumi = lumiData->muToLumi();
             if( std::abs( muToLumi ) > 0.00001 ) {
               unsigned int bcid = ctx.eventID().bunch_crossing_id();
               actualMu = lumiData->lbLuminosityPerBCIDVector().at(bcid) / muToLumi;
             }
             xaod->setActualInteractionsPerCrossing( actualMu );
             xaod->setAverageInteractionsPerCrossing(
               lumiData->lbAverageInteractionsPerCrossing() );
           }
           haveLumi = true;
         }
#endif // not XAOD_ANALYSIS or SIMULATIONBASE or GENERATIONBASE
         if (!haveLumi) {
            xaod->setActualInteractionsPerCrossing(
               aod->actualInteractionsPerCrossing() );
            xaod->setAverageInteractionsPerCrossing(
               aod->averageInteractionsPerCrossing() );
         }
      }
 
      // Copy the sub-detector flags:
      std::map< xAOD::EventInfo::EventFlagSubDet,
                EventInfo::EventFlagSubDet >::const_iterator sd_itr =
         subDetMap.begin();
      std::map< xAOD::EventInfo::EventFlagSubDet,
                EventInfo::EventFlagSubDet >::const_iterator sd_end =
         subDetMap.end();
      for( ; sd_itr != sd_end; ++sd_itr ) {
 
         // Lumi does not store event flags, or an error state:
        if( (int)sd_itr->first == (int)EventInfo::Lumi ) {
            continue;
         }
 
         // Set the event flags for this sub-detector:
         xaod->setEventFlags( sd_itr->first, aod->eventFlags( sd_itr->second ) );
 
         // Look up the error state of this sub-detector:
         std::map< EventInfo::EventFlagErrorState,
                   xAOD::EventInfo::EventFlagErrorState >::const_iterator state =
            errorStateMap.find( aod->errorState( sd_itr->second ) );
         if( state == errorStateMap.end() ) {
            REPORT_MESSAGE( MSG::FATAL )
               << "Unknown error state found for sub-detector "
               << sd_itr->second << ": " << aod->errorState( sd_itr->second );
            return StatusCode::FAILURE;
         }
 
         // Set the error state for the sub-detector:
         xaod->setErrorState( sd_itr->first, state->second );
      }
 
      // Check if it is a PileUpEventInfo object:
      const PileUpEventInfo* puei =
         dynamic_cast< const PileUpEventInfo* >( aod );
      if( puei && copyPileUpLinks ) {
         // Create the sub-event objects to fill into the output object:
         std::vector< xAOD::EventInfo::SubEvent > subEvents;
         PileUpEventInfo::SubEvent::const_iterator itr = puei->beginSubEvt();
         PileUpEventInfo::SubEvent::const_iterator end = puei->endSubEvt();
         for( ; itr != end; ++itr ) {
            // Look up the sub-event type:
           
            xAOD::EventInfo::PileUpType type = xAOD::EventInfo::Unknown;
            switch (itr->type()) {
            case PileUpTimeEventIndex::Signal:
              type = xAOD::EventInfo::Signal;
              break;
            case PileUpTimeEventIndex::MinimumBias:
              type = xAOD::EventInfo::MinimumBias;
              break;
            case PileUpTimeEventIndex::Cavern:
              type = xAOD::EventInfo::Cavern;
              break;
            case PileUpTimeEventIndex::HaloGas:
              type = xAOD::EventInfo::HaloGas;
              break;
            case PileUpTimeEventIndex::HighPtMinimumBias:
              type = xAOD::EventInfo::HighPtMinimumBias;
              break;
            case PileUpTimeEventIndex::ZeroBias:
              type = xAOD::EventInfo::ZeroBias;
              break;
            case PileUpTimeEventIndex::Unknown:
              break;
            default:
              ATH_MSG_WARNING( "Unknown sub-event type ("
                               << itr->type() << ") encountered" );
              break;
            }
 
            // Construct the link to the pile-up EventInfo object:
            ElementLink< xAOD::EventInfoContainer > link;
            link.resetWithKeyAndIndex( "PileUpEventInfo", itr->index() );
 
            // Add the new object
            subEvents.emplace_back( itr->time(),
                                                            itr->index(),
                                                            type, link );
         }
 
         // Add the vector to the EventInfo:
         xaod->setSubEvents( subEvents );
      }
 
#if !defined(XAOD_ANALYSIS) && !defined(GENERATIONBASE)
      // Fill the beam spot variables if the necessary service is available:
      if( m_beamSpotInformationAvailable && ( ! pileUpInfo ) ) {
         SG::ReadCondHandle<InDet::BeamSpotData> beamSpotHandle { m_beamSpotKey, ctx };
         xaod->setBeamPos( beamSpotHandle->beamPos()[ Amg::x ],
                           beamSpotHandle->beamPos()[ Amg::y ],
                           beamSpotHandle->beamPos()[ Amg::z ] );
         xaod->setBeamPosSigma( beamSpotHandle->beamSigma( 0 ),
                                beamSpotHandle->beamSigma( 1 ),
                                beamSpotHandle->beamSigma( 2 ) );
         xaod->setBeamPosSigmaXY( beamSpotHandle->beamSigmaXY() );
         xaod->setBeamTiltXZ( beamSpotHandle->beamTilt( 0 ) );
         xaod->setBeamTiltYZ( beamSpotHandle->beamTilt( 1 ) );
         xaod->setBeamStatus( beamSpotHandle->beamStatus() );
      }
#endif // not XAOD_ANALYSIS or GENERATIONBASE
 
      if (!eventWeights.empty()) {
        if (xaod->getStore()) {
          // Ensure that this gets added as a decoration.
          xaod->getStore()->lock();
        }
        static const xAOD::EventInfo::Decorator<std::vector<float> > ew ("mcEventWeights");
        ew (*xaod) = std::move (eventWeights);
      }
 
      // Finish with some printout:
      ATH_MSG_DEBUG( "Finished conversion EventInfo="<<aod<<" xAOD::EventInfo="<<xaod<<" content=" << *xaod );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
   }

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

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

initialize()

StatusCode xAODMaker::EventInfoCnvTool::initialize ( )

overridevirtual

Function initialising the tool.

Definition at line 61 of file EventInfoCnvTool.cxx.

   {
 
#if !defined(XAOD_ANALYSIS) && !defined(GENERATIONBASE)
      // Check if the beam position will be available or not:
      if( detStore()->contains< AthenaAttributeList >( INDET_BEAMPOS ) ) {
         m_beamSpotInformationAvailable = true;
      } else {
         // This is normal in some cases, but tell the user anyway
         ATH_MSG_INFO( "Beam spot information not available" );
         ATH_MSG_INFO( "Will not fill beam spot information into "
                       "xAOD::EventInfo" );
         m_beamSpotInformationAvailable = false;
      }
      if(m_disableBeamSpot){
         ATH_MSG_WARNING( "Beam spot information manually disabled on EventInfo object" );
         m_beamSpotInformationAvailable = false;
      }
 
      ATH_CHECK(m_beamSpotKey.initialize(m_beamSpotInformationAvailable));
#endif // not XAOD_ANALYSIS or GENERATIONBASE
 
#if !defined(XAOD_ANALYSIS) && !defined(SIMULATIONBASE) && !defined(GENERATIONBASE)
      CHECK( m_lumiDataKey.initialize (SG::AllowEmpty) );
#endif // not XAOD_ANALYSIS or GENERATIONBASE
 
      // Return gracefully:
      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 & xAODMaker::IEventInfoCnvTool::interfaceID ( )

inlinestaticinherited

Gaudi interface definition.

Definition at line 51 of file IEventInfoCnvTool.h.

                                              {
         return IID_IEventInfoCnvTool;
      }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

renounce()

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

sysStart()

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

overridevirtualinherited

Handle START transition.

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

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

m_beamSpotInformationAvailable

bool xAODMaker::EventInfoCnvTool::m_beamSpotInformationAvailable {}

private

Internal flag for the availability of the beam spot information.

Definition at line 66 of file EventInfoCnvTool.h.

{};

m_beamSpotKey

SG::ReadCondHandleKey<InDet::BeamSpotData> xAODMaker::EventInfoCnvTool::m_beamSpotKey { this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" }

private

Definition at line 62 of file EventInfoCnvTool.h.

{ this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" };

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_disableBeamSpot

Gaudi::Property<bool> xAODMaker::EventInfoCnvTool::m_disableBeamSpot { this, "DisableBeamSpot", false, "disable beamspot" }

private

Definition at line 63 of file EventInfoCnvTool.h.

{ this, "DisableBeamSpot", false, "disable beamspot" };

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_lumiDataKey

SG::ReadCondHandleKey<LuminosityCondData> xAODMaker::EventInfoCnvTool::m_lumiDataKey { this, "LumiDataKey", "", "SG key for luminosity data" }

private

Definition at line 70 of file EventInfoCnvTool.h.

{ this, "LumiDataKey", "", "SG key for luminosity data" };

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:

• EventInfoCnvTool.h
• EventInfoCnvTool.cxx