PileUpToolBase.h

Go to the documentation of this file.

/* -*- C++ -*- */
 
/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef PILEUPTOOLS_PILEUPTOOLBASE_H
#define PILEUPTOOLS_PILEUPTOOLBASE_H
#include "AthenaBaseComps/AthAlgTool.h"
#include "PileUpTools/IPileUpTool.h"
#include "TruthUtils/MagicNumbers.h"
 
class PileUpToolBase :  public extends<AthAlgTool, IPileUpTool> {
public:

  PileUpToolBase(const std::string& type,
                 const std::string& name,
                 const IInterface* parent);
 
  virtual StatusCode initialize() override {
    return StatusCode::SUCCESS;
  }


  virtual bool toProcess(int bunchXing) const override {
    //closed interval [m_firstXing,m_lastXing]
    return !((m_firstXing > bunchXing) || (bunchXing > m_lastXing));
  }

  using IPileUpTool::processAllSubEvents;
  virtual StatusCode processAllSubEvents(const EventContext&) override {
    return StatusCode::SUCCESS;
  }
  virtual StatusCode
  processBunchXing(int /*bunchXing*/,
                   SubEventIterator /*bSubEvents*/,
                   SubEventIterator /*eSubEvents*/) override {
    return StatusCode::SUCCESS;
  }

  virtual bool filterPassed() const override { return m_filterPassed; }
  virtual void resetFilter() override { m_filterPassed=true; }
 
protected:
  Gaudi::Property<int> m_firstXing{this, "FirstXing", -999,
      "First bunch-crossing in which det is live"};
  Gaudi::Property<int> m_lastXing {this, "LastXing", 999,
      "Last bunch-crossing in which det is live"};
  Gaudi::Property<int> m_vetoPileUpTruthLinks{this, "VetoPileUpTruthLinks", true,
      "Ignore links to suppressed pile-up truth"};
  bool m_filterPassed{true}; 
};
#endif