xAODTruthCnvAlg.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef XAODCREATORALGS_XAODTRUTHCNVALG_H
#define XAODCREATORALGS_XAODTRUTHCNVALG_H
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
 
#ifdef HEPMC3
// This form of ifdef is kept for convenience
#else
// The lines below I don't like. We should fix them when we update the
// the metadata to handles (ATLASRECTS-4162).
// Needs changes in HepMC to resolve.
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wkeyword-macro"
#endif
#define private public
#include "AtlasHepMC/WeightContainer.h"
#undef private
#ifdef __clang__
#pragma clang diagnostic pop
#endif
#endif
 
#include "GeneratorObjects/xAODTruthParticleLink.h"
#include "GeneratorObjects/McEventCollection.h"
 
#include "xAODTruth/TruthEvent.h"
#include "xAODTruth/TruthPileupEvent.h"
#include "xAODTruth/TruthMetaDataContainer.h"
#include "xAODTruth/TruthEventContainer.h"
#include "xAODTruth/TruthPileupEventContainer.h"
#include "xAODTruth/TruthParticleContainerFwd.h"
#include "xAODTruth/TruthVertexContainerFwd.h"
#include "StoreGate/StoreGateSvc.h"
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/WriteHandleKey.h"
#include "CxxUtils/checker_macros.h"
#include "GaudiKernel/IIncidentListener.h"
 
#include <unordered_set>
 
 
#include "AtlasHepMC/WeightContainer.h"
#include "AtlasHepMC/Polarization.h"
#include "AtlasHepMC/GenVertex_fwd.h"
#include "AtlasHepMC/GenParticle_fwd.h"
 
#include "xAODEventInfo/EventInfo.h"
 
namespace xAODMaker {

  class xAODTruthCnvAlg
    : public AthReentrantAlgorithm
    , virtual public IIncidentListener
{
  public:

    xAODTruthCnvAlg( const std::string& name, ISvcLocator* svcLoc );

    virtual StatusCode initialize() override;
    virtual StatusCode execute (const EventContext& ctx) const override;

    virtual void handle(const Incident& incident) override;
 
  private:
    // Truth metadata fields retrieved from TagInfo
    struct MetadataFields {
      std::string  lhefGenerator;
      std::string  generators;
      std::string  evgenProcess;
      std::string  evgenTune;
      std::string  hardPDF;
      std::string  softPDF;
    };

    class MetaDataWriter
    {
    public:
      StatusCode initialize (ServiceHandle<StoreGateSvc>& metaStore,
                             const std::string& metaName);
      StatusCode maybeWrite (uint32_t mcChannelNumber,
                             const HepMC::GenEvent& genEvt,
                 const MetadataFields& metaFields);
 
    private:
      std::mutex m_mutex;
      typedef std::lock_guard<std::mutex> lock_t;

      xAOD::TruthMetaDataContainer* m_tmd = nullptr;

      std::unordered_set<uint32_t> m_existingMetaDataChan;
    };

    struct VertexParticles {
      std::vector<xAOD::TruthParticle*> incoming;
      std::vector<ElementLink<xAOD::TruthParticleContainer> > incomingEL;
      std::vector<xAOD::TruthParticle*> outgoing;
      std::vector<ElementLink<xAOD::TruthParticleContainer> > outgoingEL;
    };

    typedef std::map<HepMC::ConstGenVertexPtr, VertexParticles> VertexMap;

    static void fillVertex(xAOD::TruthVertex *tv, const HepMC::ConstGenVertexPtr& gv);
    static void fillParticle(xAOD::TruthParticle *tp, const HepMC::ConstGenParticlePtr& gp);

    SG::ReadHandleKey<McEventCollection> m_aodContainerKey{ 
      this, "AODContainerName", "GEN_AOD", "The input McEvenCollection"};
    
    SG::WriteHandleKey<xAOD::TruthEventContainer> m_xaodTruthEventContainerKey{
      this, "xAODTruthEventContainerName", "TruthEvents", "Output TruthEvents container"};
    SG::WriteHandleKey<xAOD::TruthPileupEventContainer> m_xaodTruthPUEventContainerKey{
      this, "xAODTruthPileupEventContainerName", "TruthPileupEvents", "Output TruthPileupEvents container"};
    SG::WriteHandleKey<xAOD::TruthParticleContainer> m_xaodTruthParticleContainerKey{
      this, "xAODTruthParticleContainerName", "TruthParticles", "Output TruthParticles container"};
    SG::WriteHandleKey<xAOD::TruthVertexContainer> m_xaodTruthVertexContainerKey{
      this, "xAODTruthVertexContainerName", "TruthVertices", "Output TruthVertices container"};
    SG::WriteHandleKey<xAODTruthParticleLinkVector> m_truthLinkContainerKey{
      this, "TruthLinks", "xAODTruthLinks", "Output xAODTruthLinks container"};
    SG::WriteHandleKey<xAOD::TruthParticleContainer> m_lheTruthParticleContainerKey{
      this, "xAODTruthLHEParticleContainerName", "", "Output TruthLHEParticles container"};

    Gaudi::Property<bool> m_doAllPileUp{this, "WriteAllPileUpTruth", false};
    Gaudi::Property<bool> m_doInTimePileUp{this, "WriteInTimePileUpTruth", false};

    mutable MetaDataWriter m_meta ATLAS_THREAD_SAFE;

    ServiceHandle< StoreGateSvc > m_metaStore;
    std::string m_metaName;

    Gaudi::Property<bool> m_writeMetaData{this, "WriteTruthMetaData", true};

    SG::ReadHandleKey<xAOD::EventInfo> m_evtInfo {this, "EventInfo", "EventInfo", "" };

    bool           m_firstBeginRun;
    MetadataFields m_metaFields;
  }; // class xAODTruthCnvAlg
 
 
} // namespace xAODMaker
 
#endif // XAODCREATORALGS_XAODTRUTHCNVALG_H