ParticleSelectionAlg.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
// ParticleSelectionAlg.h
// Header file for class ParticleSelectionAlg
// Author: Karsten Koeneke <karsten.koeneke@cern.ch>
#ifndef EVENTUTILS_PARTICLESELECTIONALG_H
#define EVENTUTILS_PARTICLESELECTIONALG_H 1
 
// FrameWork includes
#include "GaudiKernel/ToolHandle.h"
// #include "GaudiKernel/ServiceHandle.h"
// #include "AthenaBaseComps/AthAlgorithm.h"
#include "AthAnalysisBaseComps/AthAnalysisAlgorithm.h"
#include "xAODBase/IParticleContainer.h"
#include "PATCore/IAsgSelectionTool.h"
 
// STL includes
#include <string>
#include <vector>
 
#include "ExpressionEvaluation/ExpressionParserUser.h"
 
 
class ParticleSelectionAlg
  : public ExpressionParserUser<::AthAnalysisAlgorithm>
{
 
  // Public methods:
 public:
 
  // Copy constructor:
 
  ParticleSelectionAlg( const std::string& name, ISvcLocator* pSvcLocator );
 
  virtual ~ParticleSelectionAlg();
 
 
  virtual StatusCode  initialize() override;
 
  virtual StatusCode  start() override;
 
  virtual StatusCode  execute() override;
 
  virtual StatusCode  finalize() override;
 
 private:
  template<class CONT, class AUXCONT>
  StatusCode selectParticles(const xAOD::IParticleContainer* inContainer,
                             const std::vector<int>& resultVec) const;
 
 
  // Private data:
 private:
  ToolHandleArray<IAsgSelectionTool> m_selTools;
 
  Gaudi::Property<std::string> m_evtInfoName{this, "EventInfo", "EventInfo", "Input container name"};
 
  Gaudi::Property<std::string> m_inCollKey{this, "InputContainer", "", "Input container name"};
 
  Gaudi::Property<std::string> m_outCollKey{this, "OutputContainer", "", "The name of the output container with the deep copy of selected xAOD::IParticles"};
 
  Gaudi::Property<bool> m_writeSplitAux{this, "WriteSplitOutputContainer", true, "Decide if we want to write a fully-split AuxContainer such that we can remove any variables"};
 
  Gaudi::Property<std::string> m_outOwnPolicyName{this, "OutputContainerOwnershipPolicy", "VIEW_ELEMENTS", "Defines the ownership policy of the output container"};
 
  Gaudi::Property<std::string> m_selection{this, "Selection", "", "The selection string that defines which xAOD::IParticles to select from the container"};
 
  Gaudi::Property<bool> m_doCutFlow{this, "DoCutBookkeeping", false, "If true, do the bookkeeping of how many particles passed which selection cuts"};
 
  Gaudi::Property<std::string> m_cutBKCName{this, "CutBookkeeperContainer", name(), "The name of the resulting xAOD::CutBookkeeperContainer"};
 
 
 
 
  unsigned long m_nEventsProcessed{0};
 
  SG::OwnershipPolicy m_outOwnPolicy{SG::VIEW_ELEMENTS};
 
  enum contType_t {
    UNKNOWN,
    PHOTON,
    ELECTRON,
    MUON,
    TAU,
    JET,
    PARITCLEFLOW,
    NEUTRALPARTICLE,
    TRACKPARTICLE,
    TRUTHPARTICLE,
    COMPOSITEPARTICLE,
    PARTICLE,
    CALOCLUSTER
  };
 
  contType_t m_contType{UNKNOWN};
 
  std::size_t m_cutBKStartIdx{0};
 
  std::vector<std::size_t> m_selToolIdxOffset;
 
  std::size_t m_idxSelParster{0};
 
 
};
 
// Include the templated code here. This must be done from this header file.
#include "ParticleSelectionAlg.icc"
 
 
#endif //> !EVENTUTILS_PARTICLESELECTIONALG_H