EventInfoAttListTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
/*****************************************************************************
Name    : EventInfoAttListTool.cxx
Author  : Jack Cranshaw
Created : January 2017
Purpose : create a EventInfoAttList - The Tag information associated to the event
          is built here
 
*****************************************************************************/
 
#include "EventInfoAttListTool.h"
 
#include "CoralBase/AttributeListSpecification.h"
#include "PersistentDataModel/AthenaAttributeList.h"
#include "xAODEventInfo/EventInfo.h"
 
 
StatusCode  EventInfoAttListTool::initialize() {
  ATH_MSG_DEBUG("in initialize()");
 
  m_attribListSpec  = new coral::AttributeListSpecification();
  // Note: for any attribute added here, please confirm the corresponding EventInfo member being
  // retained in DAOD smart slimming:
  // PhysicsAnalysis/DerivationFramework/DerivationFrameworkCore/python/EventInfoContent.py
  m_attribListSpec->extend("IsSimulation",    "bool");
  m_attribListSpec->extend("IsCalibration",   "bool");
  m_attribListSpec->extend("IsTestBeam",      "bool");
  m_attribListSpec->extend("McChannel",       "unsigned int");
  m_attribListSpec->extend("RunNumber",       "unsigned int");
  m_attribListSpec->extend("EventNumber",     "unsigned long long");
  m_attribListSpec->extend("LumiBlockN",      "unsigned int");
  m_attribListSpec->extend("ConditionsRun",   "unsigned int");
  m_attribListSpec->extend("EventTime",       "unsigned int");
  m_attribListSpec->extend("EventTimeNanoSec","unsigned int");
  m_attribListSpec->extend("BunchId",         "unsigned int");
  m_attribListSpec->extend("EventWeight",     "float");
  
  return AthAlgTool::initialize();
}
 
 
/* Build attribute list from EventInfo object */
std::unique_ptr<AthenaAttributeList>
EventInfoAttListTool::getAttributeListPtr(const xAOD::EventInfo& eventInfo) const
{
  // Create attributeList with appropriate attributes
  const coral::AttributeListSpecification& specRef = *m_attribListSpec;
  auto eventTag = std::make_unique<AthenaAttributeList> ( specRef );
 
  StatusCode sc = this->eventTag (*eventTag, eventInfo);
  if (sc.isFailure()) {
    ATH_MSG_WARNING("Unable to build Tag Fragments for the Event");
  }
 
  ATH_MSG_DEBUG("EventInfoAttListTool - getAttributeList() return success");
 
  return eventTag;
}
 
 
StatusCode EventInfoAttListTool::eventTag(AthenaAttributeList& eventTag, 
                                          const xAOD::EventInfo& eventInfo) const
{
  // Note: for any attribute added here, please confirm the corresponding EventInfo member being
  // retained in DAOD smart slimming:
  // PhysicsAnalysis/DerivationFramework/DerivationFrameworkCore/python/EventInfoContent.py
 
  bool isSimulation  = eventInfo.eventType(xAOD::EventInfo::IS_SIMULATION);
  bool isTestBeam    = eventInfo.eventType(xAOD::EventInfo::IS_TESTBEAM);
  bool isCalibration = eventInfo.eventType(xAOD::EventInfo::IS_CALIBRATION);
  eventTag["IsSimulation"] .data<bool>() = isSimulation;
  eventTag["IsCalibration"].data<bool>() = isCalibration;
  eventTag["IsTestBeam"]   .data<bool>() = isTestBeam;
 
  // run number and Event number 
  unsigned int       runNumber     = eventInfo.runNumber();
  unsigned int       condRunNumber = runNumber;
  unsigned long long eventNumber   = eventInfo.eventNumber();
  unsigned int       lumiBlock     = eventInfo.lumiBlock();
  unsigned int       mcChannel = 0;
  if (isSimulation)  mcChannel = eventInfo.mcChannelNumber();
  eventTag["McChannel"]    .data<unsigned int>()       = mcChannel;
  eventTag["RunNumber"]    .data<unsigned int>()       = runNumber;
  eventTag["EventNumber"]  .data<unsigned long long>() = eventNumber;
  eventTag["LumiBlockN"]   .data<unsigned int>()       = lumiBlock;
  eventTag["ConditionsRun"].data<unsigned int>()       = condRunNumber;
 
  unsigned long timeStamp   = eventInfo.timeStamp();
  unsigned long timeStampNS = eventInfo.timeStampNSOffset();
  unsigned long bunchId     = eventInfo.bcid();
  eventTag["EventTime"]       .data<unsigned int>() = timeStamp;
  eventTag["EventTimeNanoSec"].data<unsigned int>() = timeStampNS;
  eventTag["BunchId"]         .data<unsigned int>() = bunchId;
 
  // event weight 
  // used for event weighting in monte carlo or just an event count in data
  float evweight = 1;
  if (isSimulation) evweight = eventInfo.mcEventWeight();
  eventTag["EventWeight"].data<float>() = evweight;
 
  return StatusCode::SUCCESS;
 
}
 
 
StatusCode  EventInfoAttListTool::finalize() {
  ATH_MSG_DEBUG("in finalize()");
  m_attribListSpec->release();
  m_attribListSpec = nullptr;
  return AthAlgTool::finalize();
}