BkgStreamsCache.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef PILEUPTOOLS_BKGSTREAMSCACHE_H
# define PILEUPTOOLS_BKGSTREAMSCACHE_H
 
#include <string>
#include <vector>
#include <functional>
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ServiceHandle.h"
#include "Gaudi/Property.h"
#include "PileUpTools/PileUpStream.h"
#include "PileUpTools/IBkgStreamsCache.h"
 
class IEvtSelector;
class IAtRndmGenSvc;
class IBeamIntensity;
namespace CLHEP {
  class RandFlat;
  class RandPoisson;
}
 
 
class BkgStreamsCache :
  public extends<AthAlgTool, IBkgStreamsCache>
{
public:
  BkgStreamsCache( const std::string&, const std::string&, const IInterface*);
  virtual ~BkgStreamsCache();
 
  virtual StatusCode initialize() override final;
  virtual StatusCode finalize() override final;
  virtual StatusCode setup(int firstXing,
                           unsigned int nXings,
                           unsigned int firstStore,
                           IBeamIntensity*) override final;
  virtual void newEvent() override final;
  virtual void resetEvtsPerXingScaleFactor(float sf) override final;
  virtual StatusCode addSubEvts(unsigned int iXing,
                                xAOD::EventInfo* overlaidEvent,
                                int t0BinCenter) override final;
  virtual StatusCode addSubEvts(unsigned int iXing,
                                xAOD::EventInfo* overEvent,
                                int t0BinCenter, bool loadEventProxies, unsigned int /*BCID*/) override final;
  virtual unsigned int nStores() const override final { return m_nStores; }
 
  long collXing() { return m_collXing; }
  long collXingPoisson();
  unsigned int numberOfBkgForBunchCrossingIgnoringBeamIntensity(unsigned int iXing) const;
  unsigned int numberOfBkgForBunchCrossingDefaultImpl(unsigned int iXing) const;
  unsigned int numberOfCavernBkgForBunchCrossing(unsigned int iXing) const;
private:
  const xAOD::EventInfo* nextEvent(bool isCentralBunchCrossing);
  StatusCode nextEvent_passive(bool isCentralBunchCrossing);
  PileUpStream* current();
 
  unsigned int setNEvtsXing(unsigned int iXing);
  unsigned int nEvtsXing(unsigned int iXing) const;
 
  typedef std::vector<PileUpStream> StreamVector;
  bool alreadyInUse(StreamVector::size_type iStream);
  StreamVector::iterator m_cursor;
  StreamVector m_streams;
  std::vector<bool> m_usedStreams;
  unsigned int m_nXings;
  unsigned int m_nStores;
  std::vector<unsigned int> m_nEvtsXing;
 
 
  Gaudi::Property<float> m_collXing;
  Gaudi::Property<float> m_occupationFraction;
  Gaudi::Property<std::string> m_collDistrName;
  ServiceHandle<IEvtSelector> m_selecName;
  Gaudi::Property<float> m_readDownscale;
  ServiceHandle<IAtRndmGenSvc> m_atRndmSvc;
  Gaudi::Property<std::string> m_randomStreamName;
  Gaudi::CheckedProperty<unsigned short> m_pileUpEventTypeProp;
  void PileUpEventTypeHandler(Gaudi::Details::PropertyBase&);
  xAOD::EventInfo::PileUpType m_pileUpEventType;
  Gaudi::Property<unsigned short> m_subtractBC0;
  Gaudi::Property<bool> m_ignoreBM;
  CLHEP::RandFlat* m_readEventRand;
  CLHEP::RandFlat* m_chooseEventRand;
  CLHEP::RandPoisson* m_collXingPoisson;
  std::function< long() > m_f_collDistr;
  std::function< unsigned int(unsigned int) > m_f_numberOfBackgroundForBunchCrossing;
  float m_collXingSF;
  Gaudi::Property<bool> m_ignoreSF;
  int m_zeroXing;
  IBeamIntensity* m_beamInt;
  Gaudi::Property<bool> m_forceReadForBC0;
 
};
 
#endif // PILEUPTOOLS_BKGSTREAMSCACHE_H