TgcDigitizationTool.h

Go to the documentation of this file.

/* -*- C++ -*- */
 
/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef MUONDIGITIZATION_TGC_DIGITIZATIONTOOL_H
#define MUONDIGITIZATION_TGC_DIGITIZATIONTOOL_H
 
#include "AthenaKernel/IAthRNGSvc.h"
#include "GaudiKernel/ServiceHandle.h"
#include "HitManagement/TimedHitCollection.h"
#include "MuonCondData/TgcDigitASDposData.h"
#include "MuonCondData/TgcDigitCrosstalkData.h"
#include "MuonCondData/TgcDigitTimeOffsetData.h"
#include "MuonDigitContainer/TgcDigitContainer.h"
#include "MuonSimData/MuonSimDataCollection.h"
#include "MuonSimEvent/TGCSimHit.h"
#include "MuonSimEvent/TGCSimHitCollection.h"
#include "PileUpTools/PileUpMergeSvc.h"
#include "PileUpTools/PileUpToolBase.h"
 
class PileUpMergeSvc;
class TgcDigitMaker;
class TgcHitIdHelper;
class TgcIdHelper;
 
namespace CLHEP {
class HepRandomEngine;
}
 
namespace MuonGM {
class MuonDetectorManager;
}
 
class TgcDigitizationTool : public PileUpToolBase {
   public:
    TgcDigitizationTool(const std::string& type, const std::string& name,
                        const IInterface* parent);
    virtual StatusCode initialize() override final;
 
    virtual StatusCode prepareEvent(
        const EventContext& ctx, unsigned int /*nInputEvents*/) override final;

    virtual StatusCode processBunchXing(
        int bunchXing, SubEventIterator bSubEvents,
        SubEventIterator eSubEvents) override final;

    virtual StatusCode mergeEvent(const EventContext& ctx) override final;

    virtual StatusCode processAllSubEvents(
        const EventContext& ctx) override final;

    virtual StatusCode finalize() override final;
 
   private:
    StatusCode getNextEvent(const EventContext& ctx);
    StatusCode digitizeCore(const EventContext& ctx);
 
   protected:
    ServiceHandle<PileUpMergeSvc> m_mergeSvc{
        this, "PileUpMergeSvc", "PileUpMergeSvc", ""};  // Pile up service
    ServiceHandle<IAthRNGSvc> m_rndmSvc{this, "RndmSvc", "AthRNGSvc",
                                        ""};  // Random number service
 
   private:
    const TgcHitIdHelper* m_hitIdHelper{};
    const TgcIdHelper* m_idHelper{};
    const MuonGM::MuonDetectorManager* m_mdManager{};
    TgcDigitMaker* m_digitizer{};
    TimedHitCollection<TGCSimHit>* m_thpcTGC{};
    std::list<TGCSimHitCollection*> m_TGCHitCollList;
 
    Gaudi::Property<bool> m_onlyUseContainerName{
        this, "OnlyUseContainerName", true,
        "Don't use the ReadHandleKey directly. Just extract the container name "
        "from it."};
    Gaudi::Property<bool> m_doFourBunchDigitization{
        this, "FourBunchDigitization", true,
        "Do the four bunch digitization since Run-3"};
    SG::ReadHandleKey<TGCSimHitCollection> m_hitsContainerKey{
        this, "InputObjectName", "TGC_Hits", "name of the input object"};
    std::string m_inputHitCollectionName{""};
    SG::ReadCondHandleKey<TgcDigitASDposData> m_readCondKey_ASDpos{
        this, "TGCDigitASDposKey", "",
        "ReadCondHandleKey for TGCDigitASDposData"};
    SG::ReadCondHandleKey<TgcDigitTimeOffsetData> m_readCondKey_TimeOffset{
        this, "TGCDigitTimeOffsetKey", "",
        "ReadCondHandleKey for TGCDigitTimeOffsetData"};
    SG::ReadCondHandleKey<TgcDigitCrosstalkData> m_readCondKey_Crosstalk{
        this, "TGCDigitCrosstalkKey", "",
        "ReadCondHandleKey for TGCDigitCrosstalkData"};
    SG::WriteHandleKey<TgcDigitContainer> m_outputDigitCollectionKey{
        this, "OutputObjectName", "TGC_DIGITS",
        "WriteHandleKey for Output TgcDigitContainer"};  // name of the output
                                                         // digits
    SG::WriteHandleKey<MuonSimDataCollection> m_outputSDO_CollectionKey{
        this, "OutputSDOName", "TGC_SDO",
        "WriteHandleKey for Output MuonSimDataCollection"};  // name of the
                                                             // output SDOs
 
    // pileup truth veto
    Gaudi::Property<bool> m_includePileUpTruth{this, "IncludePileUpTruth", true,
                                               "Include pile-up truth info"};
};
#endif  // MUONDIGITIZATION_TGC_DIGITIZATIONTOOL_H