CscOverlay.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
// Overlaying RDOs from two different events for InDet subdetectors.
//
// Andrei Gaponenko <agaponenko@lbl.gov>, 2006, 2007
//
// Ketevi A. Assamagan <ketevi@bnl.gov>, March 2008
 
#ifndef CSCOVERLAY_CSCOVERLAY_H
#define CSCOVERLAY_CSCOVERLAY_H
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ToolHandle.h"
#include "StoreGate/ReadHandleKey.h"            // for ReadHandleKey
#include "StoreGate/WriteHandleKey.h"           // for WriteHandleKey
 
#include "MuonRDO/CscRawDataContainer.h"        //ReadHandleKey template param
#include "CscCalibTools/ICscCalibTool.h"        //ToolHandle template param
#include "MuonCSC_CnvTools/ICSC_RDO_Decoder.h"  //ToolHandle template param
#include "AthenaKernel/IAthRNGSvc.h"            //ServiceHandle template param
#include "MuonIdHelpers/IMuonIdHelperSvc.h"     //ServiceHandle template param
 
#include <cstdint>                              // for uint16_t, uint32_t
#include <vector>
#include <string>
#include <map>
#include <memory>
 
namespace CLHEP {
  class HepRandomEngine;
}
 
class CscRawData;
class EventContext;
class ISvcLocator;
class StatusCode;
 
class CscOverlay : public AthReentrantAlgorithm {
public:
 
  CscOverlay(const std::string &name,ISvcLocator *pSvcLocator);
 
  virtual StatusCode initialize() override final;
  virtual StatusCode execute(const EventContext& ctx) const override final;
 
private:

  StatusCode overlayContainer(const CscRawDataContainer *bkgContainer,
                              const CscRawDataContainer *signalContainer,
                              CscRawDataContainer *outputContainer) const;

  std::unique_ptr<CscRawDataCollection> copyCollection(const CscRawDataCollection *collection,
                                                       bool propertiesOnly = false) const;

  void mergeCollections(const CscRawDataCollection *bkgCollection,
                        const CscRawDataCollection *signalCollection,
                        CscRawDataCollection *outputCollection,
                        CLHEP::HepRandomEngine *rndmEngine) const;

  void spuData( const CscRawDataCollection * coll, const uint16_t spuID, std::vector<const CscRawData*>& data) const;

  uint32_t stripData ( const std::vector<const CscRawData*>& data,
                       const unsigned int numSamples,
                       std::map< int,std::vector<uint16_t> >& samples,
                       uint32_t& hash,
                       const uint16_t spuID,
                       const int gasLayer, bool isdata) const;

  std::vector<CscRawData*> overlay( const std::map< int,std::vector<uint16_t> >& sigSamples,
                                    const std::map< int,std::vector<uint16_t> >& ovlSamples,
                                    const uint32_t address,
                                    const uint16_t spuID,
                                    const uint16_t collId,
                                    const uint32_t hash,
                                    CLHEP::HepRandomEngine *rndmEngine) const;
 
  //Whether the data needs to be fliped by 49-strip for bug#56002
  bool needtoflip(const int address) const;
 
  // ----------------------------------------------------------------
 
  // jO controllable properties.
  // "Main" containers are read, have data from "overlay" containers added,
  // and written out with the original SG keys.
  SG::ReadHandleKey<CscRawDataContainer> m_bkgInputKey{this,"BkgInputKey","Bkg_CSCRDO",""};
  SG::ReadHandleKey<CscRawDataContainer> m_signalInputKey{this,"SignalInputKey","Sig_CSCRDO",""};
  SG::WriteHandleKey<CscRawDataContainer> m_outputKey{this,"OutputKey","CSCRDO",""};
 
  Gaudi::Property<bool> m_isDataOverlay{this, "isDataOverlay", false, ""};
  ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
  ToolHandle<ICscCalibTool> m_cscCalibTool{this, "CalibTool", "CscCalibTool", ""};
  ToolHandle<Muon::ICSC_RDO_Decoder> m_cscRdoDecoderTool{this, "CscRdoDecoderTool", "Muon::CscRDO_Decoder", ""};
 
  ServiceHandle <IAthRNGSvc> m_rndmSvc{this, "RndmSvc", "AthRNGSvc", "Random Number Service"};      // Random number service
};
 
#endif/*CSCOVERLAY_CSCOVERLAY_H*/