TruthParticleCnvTool.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
// TruthParticleCnvTool.h 
// Header file for class TruthParticleCnvTool
// Author: S.Binet<binet@cern.ch>
// Purpose: Create a TruthParticleContainer from a HepMC::GenEvent
#ifndef MCPARTICLETOOLS_TRUTHPARTICLECNVTOOL_H
#define MCPARTICLETOOLS_TRUTHPARTICLECNVTOOL_H

 
#include "HepPDT/ParticleDataTable.hh"
 
// Framework includes
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthAlgTool.h"
 
#include "EventKernel/IParticle.h" //> for ParticleDataType
 
// CLHEP/HepMC includes
#include "GeneratorObjects/McEventCollection.h"
 
// McParticleKernel includes
#include "McParticleKernel/ITruthParticleCnvTool.h"
 
#include "McParticleEvent/PileUpClassification.h"
 
// McParticleEvent includes
#include "McParticleEvent/TruthParticleContainer.h"
 
// Forward declarations
class McEventCollection;
class TruthParticle;
class ITruthIsolationTool;
 
class TruthParticleCnvTool : public extends<AthAlgTool, ITruthParticleCnvTool>
{
  // Public methods: 
 public:

  TruthParticleCnvTool( const std::string& type,
            const std::string& name, 
            const IInterface* parent );
  
  virtual ~TruthParticleCnvTool ();
  
  // Athena's Hooks
  virtual StatusCode initialize() override;
  virtual StatusCode execute() const override;
  virtual StatusCode execute (const EventContext& ctx) const override;
  
  // Const methods: 

  StatusCode convert( const McEventCollection* mcEvts,
              const unsigned int genEvtIndex,
              TruthParticleContainer* mcParts,
              const ITruthParticleVisitor* visitor ) const override;

  // Non-const methods: 
  
  void setDataType( const int type );
  void setVxCandidateName( const std::string& name );

  // Private data: 
 private:

  ParticleDataType::DataType m_dataType;
  int m_dataType_int;
  
  std::string m_vxCandidatesName;

  SG::ReadHandleKey<McEventCollection> m_mcEventsReadHandleKey{this,"McEvents","GEN_AOD","ReadHandleKey for the input McEventCollection, from which the TruthParticles will be made from"};

  SG::WriteHandleKey<TruthParticleContainer>  m_mcPartsOutputWriteHandleKey{this,"TruthParticlesOutput","SpclMC","WriteHandleKey for the output truth particles (built from the McEventCollection)"};

  const HepPDT::ParticleDataTable * m_pdt;

  PileUpClassification::PileuType_t m_selectSignalType;

  int m_selectSignalTypeProp;
 
 
  
  // Protected data: 
 protected: 

  BooleanProperty m_doEtIsolation;
 
  typedef ToolHandle<ITruthIsolationTool> IsolTool_t;

   IsolTool_t m_isolationTool;
 
};

inline void TruthParticleCnvTool::setDataType( const int type ) 
{ 
  m_dataType = ParticleDataType::DataType(type); 
}
 
inline void TruthParticleCnvTool::setVxCandidateName( const std::string& name ) 
{ 
  m_vxCandidatesName = name; 
}
 
#endif // MCPARTICLETOOLS_TRUTHPARTICLECNVTOOL_H