PhysicsAnalysis/TruthParticleID/McParticleEvent/McParticleEvent/TruthParticle.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
*/
 
// TruthParticle.h 
// Header file for class TruthParticle
// Author  : Frank Paige Created : Jan 2004
// Author  : Ketevi A. Assamagan Updated : May 2004
// Author  : Sebastien Binet Updated : Jan 2005
#ifndef MCPARTICLEEVENT_TRUTHPARTICLE_H 
#define MCPARTICLEEVENT_TRUTHPARTICLE_H 

 
// STL includes
#include <vector>
 
// HepMC / CLHEP includes
#include "CLHEP/Vector/LorentzVector.h"
#include "AtlasHepMC/GenParticle.h"
#include "AtlasHepMC/Polarization.h"
#include "AtlasHepMC/Flow.h"
 
// Gaudi includes
 
// EventKernel includes
#include "EventKernel/IParticle.h"
 
// FourMom includes
 
// ParticleEvent includes
#include "ParticleEvent/ParticleImpl.h"
 
// McParticleEvent includes
#include "McParticleEvent/TruthParticleParamDefs.h"
#include "McParticleEvent/TruthParticleNavigation.h"
#include "McParticleEvent/TruthParticleMomentum.h"
#include "McParticleEvent/TruthParticleBase.h"
#include "McParticleEvent/TruthEtIsolations.h"
 
// Forward declaration
namespace Trk   { class RecVertex; }
class TruthParticleContainer;
 
class TruthParticle : public ParticleImpl< 
                                TruthParticleNavigation,
                        TruthParticleMomentum,
                        TruthParticleBase
                     >
{ 

  // Public typedefs: 
 public: 
 
  // for readability and lazy people
  typedef ParticleImpl< TruthParticleNavigation,
            TruthParticleMomentum,
            TruthParticleBase
      > TruthParticleImpl_t;
 
  typedef std::size_t evtIndex_t;
  // Public methods: 
 public: 

  TruthParticle();
  
  TruthParticle( const TruthParticle& rhs );
  
  TruthParticle( HepMC::ConstGenParticlePtr genParticle, 
         const TruthParticleContainer * container = 0 );

  TruthParticle& operator=( const TruthParticle& rhs );

  ~TruthParticle();

  // Const methods: 

  HepMC::ConstGenParticlePtr genMother(const std::size_t i=0) const;

  HepMC::ConstGenParticlePtr genParticle() const;

  HepMC::ConstGenParticlePtr genChild( const std::size_t i ) const;

  
  int status() const;

  const HepMC::Flow flow() const;

  int flow( int code_index ) const;

  const HepMC::Polarization polarization() const;

  int barcode() const;

  int id() const;

  long compressedExtBarCode() const { return 0; };

  const TruthParticle * mother(const std::size_t i=0) const;

  const TruthParticle * child( const std::size_t i ) const;

  bool hasMother( const int pdgId ) const;

  bool hasChild( const int pdgId ) const;

  bool hasMother( const int pdgId, std::vector<unsigned int>& indices ) const;

  bool hasChild( const int pdgId, std::vector<unsigned int>& indices ) const;
 
  // Accessor functions
  
  bool hasEtIsol() const;

  double etIsol( const TruthParticleParameters::ConeSize coneIdx ) const;

  const TruthEtIsolations::EtIsol_t* etIsol() const;

  unsigned int nParents() const;
  
  unsigned int nDecay() const;

  CLHEP::HepLorentzVector transformVector( const HepMC::FourVector&  ) const;
  
  CLHEP::HepLorentzVector pDecay( const std::size_t i ) const;

  int pdgDecay( const std::size_t i ) const;
 
  evtIndex_t genEventIndex() const {return m_nGenEventIdx;}

  // Non-const methods: 
 
  // Set functions

  void setCharge( const ChargeType charge );
  
  void set4Mom( const HepMC::FourVector& hlv ) 
  { this->momentumBase().set4Mom(hlv); }
 
  // un-hide base-class' set4Mom
  using TruthParticleImpl_t::set4Mom;

  void setGenEventIndex( size_t index );

  // Protected methods: 
 protected: 
  
  void setGenParticle( HepMC::ConstGenParticlePtr particle );
 
 

  // Protected data: 
 protected: 

  const TruthParticleContainer* m_container;

  std::vector<int> m_mothers;

  std::vector<int> m_children;

  evtIndex_t m_nGenEventIdx;
 
}; 

// I/O functions
std::ostream& operator<<( std::ostream& out, const TruthParticle& mc );

// Inline methods: 
 
inline TruthParticle::~TruthParticle() 
{}
 
inline HepMC::ConstGenParticlePtr TruthParticle::genParticle() const
{
  return this->particleBase().genParticle();
}
 
inline int TruthParticle::status() const
{
  return genParticle()->status();
}
 
inline const HepMC::Flow TruthParticle::flow() const
{
  return HepMC::flow(genParticle());
}
 
inline int TruthParticle::flow( int code_index ) const
{
  return HepMC::flow(genParticle(),code_index);
}
 
inline const HepMC::Polarization TruthParticle::polarization() const
{
  return HepMC::polarization(genParticle());
}
 
inline int TruthParticle::barcode() const
{
  return HepMC::barcode(genParticle());
}
 
inline int TruthParticle::id() const
{
  return genParticle()->id();
}
 
inline unsigned int TruthParticle::nParents() const 
{ return m_mothers.size(); }
  
inline unsigned int TruthParticle::nDecay() const 
{ return m_children.size(); }
 
inline void TruthParticle::setCharge( const ChargeType charge )
{
  this->particleBase().setCharge( charge );
}
 
inline CLHEP::HepLorentzVector TruthParticle::transformVector( const HepMC::FourVector& fv ) const
{
    CLHEP::HepLorentzVector hlv(fv.x(),fv.y(),fv.z(),fv.t());
    return hlv;
}  
 
inline void TruthParticle::setGenEventIndex( size_t index ){
  m_nGenEventIdx = index;
}
 
  
#endif //> MCPARTICLEEVENT_TRUTHPARTICLE_H