include/Helpers/MCParticleHelper.h

0001 /**
0002  *  @file   PandoraSDK/include/Helpers/MCParticleHelper.h
0003  *
0004  *  @brief  Header file for the mc particle helper class.
0005  *
0006  *  $Log: $
0007  */
0008 #ifndef PANDORA_MC_PARTICLE_HELPER_H
0009 #define PANDORA_MC_PARTICLE_HELPER_H 1
0010
0011 #include "Pandora/PandoraInternal.h"
0012 #include "Pandora/StatusCodes.h"
0013
0014 namespace pandora
0015 {
0016
0017 /**
0018  *  @brief  MCParticleHelper class
0019  */
0020 class MCParticleHelper
0021 {
0022 public:
0023     /**
0024      *  @brief  Find the mc particle making the largest contribution to a specified calo hit, track or cluster
0025      *
0026      *  @param  pT address of the calo hit, track or cluster to examine
0027      *
0028      *  @return address of the main mc particle
0029      */
0030     template <typename T>
0031     static const MCParticle *GetMainMCParticle(const T *const pT);
0032 };
0033
0034 } // namespace pandora
0035
0036 #endif // #ifndef PANDORA_MC_PARTICLE_HELPER_H