Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
JetTruthEval Class Reference

#include <coresoftware/blob/master/simulation/g4simulation/g4eval/JetTruthEval.h>

+ Collaboration diagram for JetTruthEval:

Public Member Functions

 JetTruthEval (PHCompositeNode *topNode, const std::string &truthjetname)
 example truthjetname: AntiKt_Truth_r03
 
virtual ~JetTruthEval ()
 
void next_event (PHCompositeNode *topNode)
 reinitialize the eval for a new event
 
void do_caching (bool do_cache)
 activate or deactivate the memory caching inside the evaluation module
 
void set_strict (bool strict)
 
unsigned int get_errors ()
 get a count of the errors discovered thus far
 
void set_verbosity (int verbosity)
 adjust the messaging from the evalutaion module
 
void set_track_nodename (const std::string &name)
 
SvtxEvalStackget_svtx_eval_stack ()
 get a copy of the lower level eval and its memory cache
 
CaloEvalStackget_cemc_eval_stack ()
 get a copy of the lower level eval and its memory cache
 
CaloEvalStackget_hcalin_eval_stack ()
 get a copy of the lower level eval and its memory cache
 
CaloEvalStackget_hcalout_eval_stack ()
 get a copy of the lower level eval and its memory cache
 
CaloEvalStackget_femc_eval_stack ()
 get a copy of the lower level eval and its memory cache
 
CaloEvalStackget_fhcal_eval_stack ()
 get a copy of the lower level eval and its memory cache
 
CaloEvalStackget_eemc_eval_stack ()
 get a copy of the lower level eval and its memory cache
 
Jetget_truth_jet (PHG4Particle *truthparticle)
 which truth jet in the specified node contains this truth particle?
 
std::set< PHG4Particle * > all_truth_particles (Jet *truthjet)
 which truth particle contributed to this truth jet?
 
std::set< PHG4Shower * > all_truth_showers (Jet *truthjet)
 which showers were left by particles contributing to this truth jet?
 
std::set< PHG4Hit * > all_truth_hits (Jet *truthjet)
 which truth hits were left by particles contributing to this truth jet?
 

Private Member Functions

void get_node_pointers (PHCompositeNode *topNode)
 

Private Attributes

std::string _truthjetname
 
SvtxEvalStack _svtxevalstack
 
CaloEvalStack _cemcevalstack
 
CaloEvalStack _hcalinevalstack
 
CaloEvalStack _hcaloutevalstack
 
CaloEvalStack _femcevalstack
 
CaloEvalStack _fhcalevalstack
 
CaloEvalStack _eemcevalstack
 
PHG4TruthInfoContainer_truthinfo = nullptr
 
JetContainer_truthjets = nullptr
 
bool _strict = false
 
int _verbosity = 1
 
unsigned int _errors = 0
 
bool _do_cache = true
 
std::map< Jet *, std::set
< PHG4Particle * > > 
_cache_all_truth_particles
 
std::map< Jet *, std::set
< PHG4Shower * > > 
_cache_all_truth_showers
 
std::map< Jet *, std::set
< PHG4Hit * > > 
_cache_all_truth_hits
 
std::map< PHG4Particle *, Jet * > _cache_get_truth_jet
 

Detailed Description

Definition at line 21 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 21 of file JetTruthEval.h

Constructor & Destructor Documentation

JetTruthEval::JetTruthEval ( PHCompositeNode topNode,
const std::string &  truthjetname 
)

example truthjetname: AntiKt_Truth_r03

Definition at line 20 of file JetTruthEval.cc.

View newest version in sPHENIX GitHub at line 20 of file JetTruthEval.cc

References get_node_pointers().

+ Here is the call graph for this function:

JetTruthEval::~JetTruthEval ( )
virtual

Definition at line 34 of file JetTruthEval.cc.

View newest version in sPHENIX GitHub at line 34 of file JetTruthEval.cc

References _errors, and _verbosity.

Member Function Documentation

std::set< PHG4Hit * > JetTruthEval::all_truth_hits ( Jet truthjet)

which truth hits were left by particles contributing to this truth jet?

Definition at line 179 of file JetTruthEval.cc.

View newest version in sPHENIX GitHub at line 179 of file JetTruthEval.cc

References _cache_all_truth_hits, _do_cache, _errors, _strict, _svtxevalstack, SvtxTruthEval::all_truth_hits(), all_truth_particles(), assert, SvtxEvalStack::get_truth_eval(), and particle.

+ Here is the call graph for this function:

std::set< PHG4Particle * > JetTruthEval::all_truth_particles ( Jet truthjet)

which truth particle contributed to this truth jet?

Definition at line 62 of file JetTruthEval.cc.

View newest version in sPHENIX GitHub at line 62 of file JetTruthEval.cc

References _cache_all_truth_particles, _do_cache, _errors, _strict, _truthinfo, assert, Jet::get_comp_vec(), PHG4TruthInfoContainer::GetParticle(), index, Jet::PARTICLE, PHWHERE, and parse_cmake_options::source.

Referenced by all_truth_hits(), all_truth_showers(), JetRecoEval::get_energy_contribution(), PhotonJet::GetRecoHadronsAndJets(), AnaTutorial::getTruthJets(), and PhotonJet::process_event().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

std::set< PHG4Shower * > JetTruthEval::all_truth_showers ( Jet truthjet)

which showers were left by particles contributing to this truth jet?

Definition at line 123 of file JetTruthEval.cc.

View newest version in sPHENIX GitHub at line 123 of file JetTruthEval.cc

References _cache_all_truth_showers, _cemcevalstack, _do_cache, _errors, _strict, all_truth_particles(), assert, CaloTruthEval::get_primary_shower(), CaloEvalStack::get_truth_eval(), and particle.

+ Here is the call graph for this function:

void JetTruthEval::do_caching ( bool  do_cache)
inline

activate or deactivate the memory caching inside the evaluation module

Definition at line 33 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 33 of file JetTruthEval.h

References _cemcevalstack, _do_cache, _eemcevalstack, _femcevalstack, _fhcalevalstack, _hcalinevalstack, _hcaloutevalstack, _svtxevalstack, CaloEvalStack::do_caching(), and SvtxEvalStack::do_caching().

Referenced by JetRecoEval::do_caching().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CaloEvalStack* JetTruthEval::get_cemc_eval_stack ( )
inline

get a copy of the lower level eval and its memory cache

Definition at line 88 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 88 of file JetTruthEval.h

References _cemcevalstack.

Referenced by JetRecoEval::get_cemc_eval_stack().

+ Here is the caller graph for this function:

CaloEvalStack* JetTruthEval::get_eemc_eval_stack ( )
inline

get a copy of the lower level eval and its memory cache

Definition at line 103 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 103 of file JetTruthEval.h

References _eemcevalstack.

Referenced by JetRecoEval::get_eemc_eval_stack().

+ Here is the caller graph for this function:

unsigned int JetTruthEval::get_errors ( )
inline

get a count of the errors discovered thus far

Definition at line 60 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 60 of file JetTruthEval.h

References _cemcevalstack, _eemcevalstack, _errors, _femcevalstack, _fhcalevalstack, _hcalinevalstack, _hcaloutevalstack, _svtxevalstack, CaloEvalStack::get_errors(), and SvtxEvalStack::get_errors().

Referenced by JetRecoEval::get_errors().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

CaloEvalStack* JetTruthEval::get_femc_eval_stack ( )
inline

get a copy of the lower level eval and its memory cache

Definition at line 97 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 97 of file JetTruthEval.h

References _femcevalstack.

Referenced by JetRecoEval::get_femc_eval_stack().

+ Here is the caller graph for this function:

CaloEvalStack* JetTruthEval::get_fhcal_eval_stack ( )
inline

get a copy of the lower level eval and its memory cache

Definition at line 100 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 100 of file JetTruthEval.h

References _fhcalevalstack.

Referenced by JetRecoEval::get_fhcal_eval_stack().

+ Here is the caller graph for this function:

CaloEvalStack* JetTruthEval::get_hcalin_eval_stack ( )
inline

get a copy of the lower level eval and its memory cache

Definition at line 91 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 91 of file JetTruthEval.h

References _hcalinevalstack.

Referenced by JetRecoEval::get_hcalin_eval_stack().

+ Here is the caller graph for this function:

CaloEvalStack* JetTruthEval::get_hcalout_eval_stack ( )
inline

get a copy of the lower level eval and its memory cache

Definition at line 94 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 94 of file JetTruthEval.h

References _hcaloutevalstack.

Referenced by JetRecoEval::get_hcalout_eval_stack().

+ Here is the caller graph for this function:

void JetTruthEval::get_node_pointers ( PHCompositeNode topNode)
private

Definition at line 313 of file JetTruthEval.cc.

View newest version in sPHENIX GitHub at line 313 of file JetTruthEval.cc

References _truthinfo, _truthjetname, _truthjets, and PHWHERE.

Referenced by JetTruthEval(), and next_event().

+ Here is the caller graph for this function:

SvtxEvalStack* JetTruthEval::get_svtx_eval_stack ( )
inline

get a copy of the lower level eval and its memory cache

Definition at line 85 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 85 of file JetTruthEval.h

References _svtxevalstack.

Referenced by JetRecoEval::get_svtx_eval_stack(), and get_truth_jet().

+ Here is the caller graph for this function:

Jet * JetTruthEval::get_truth_jet ( PHG4Particle truthparticle)

which truth jet in the specified node contains this truth particle?

Definition at line 246 of file JetTruthEval.cc.

View newest version in sPHENIX GitHub at line 246 of file JetTruthEval.cc

References _cache_get_truth_jet, _do_cache, _errors, _strict, _truthinfo, _truthjets, assert, get_svtx_eval_stack(), PHG4TruthInfoContainer::GetParticle(), and index.

Referenced by JetRecoEval::all_truth_jets().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void JetTruthEval::next_event ( PHCompositeNode topNode)

reinitialize the eval for a new event

Definition at line 45 of file JetTruthEval.cc.

View newest version in sPHENIX GitHub at line 45 of file JetTruthEval.cc

References _cache_all_truth_hits, _cache_all_truth_particles, _cache_all_truth_showers, _cache_get_truth_jet, _cemcevalstack, _femcevalstack, _fhcalevalstack, _hcalinevalstack, _hcaloutevalstack, _svtxevalstack, get_node_pointers(), CaloEvalStack::next_event(), and SvtxEvalStack::next_event().

Referenced by JetRecoEval::next_event().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void JetTruthEval::set_strict ( bool  strict)
inline

strict mode will assert when an error is detected non-strict mode will notice and report at the End()

Definition at line 47 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 47 of file JetTruthEval.h

References _cemcevalstack, _eemcevalstack, _femcevalstack, _fhcalevalstack, _hcalinevalstack, _hcaloutevalstack, _strict, _svtxevalstack, CaloEvalStack::set_strict(), and SvtxEvalStack::set_strict().

Referenced by JetRecoEval::set_strict().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void JetTruthEval::set_track_nodename ( const std::string &  name)
inline

Definition at line 79 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 79 of file JetTruthEval.h

References _svtxevalstack, and SvtxEvalStack::set_track_nodename().

Referenced by JetRecoEval::set_track_nodename().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void JetTruthEval::set_verbosity ( int  verbosity)
inline

adjust the messaging from the evalutaion module

Definition at line 66 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 66 of file JetTruthEval.h

References _cemcevalstack, _eemcevalstack, _femcevalstack, _fhcalevalstack, _hcalinevalstack, _hcaloutevalstack, _svtxevalstack, _verbosity, CaloEvalStack::set_verbosity(), SvtxEvalStack::set_verbosity(), and verbosity.

Referenced by JetRecoEval::set_verbosity().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

std::map<Jet*, std::set<PHG4Hit*> > JetTruthEval::_cache_all_truth_hits
private

Definition at line 143 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 143 of file JetTruthEval.h

Referenced by all_truth_hits(), and next_event().

std::map<Jet*, std::set<PHG4Particle*> > JetTruthEval::_cache_all_truth_particles
private

Definition at line 141 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 141 of file JetTruthEval.h

Referenced by all_truth_particles(), and next_event().

std::map<Jet*, std::set<PHG4Shower*> > JetTruthEval::_cache_all_truth_showers
private

Definition at line 142 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 142 of file JetTruthEval.h

Referenced by all_truth_showers(), and next_event().

std::map<PHG4Particle*, Jet*> JetTruthEval::_cache_get_truth_jet
private

Definition at line 144 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 144 of file JetTruthEval.h

Referenced by get_truth_jet(), and next_event().

CaloEvalStack JetTruthEval::_cemcevalstack
private

Definition at line 126 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 126 of file JetTruthEval.h

Referenced by all_truth_showers(), do_caching(), get_cemc_eval_stack(), get_errors(), next_event(), set_strict(), and set_verbosity().

bool JetTruthEval::_do_cache = true
private

Definition at line 140 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 140 of file JetTruthEval.h

Referenced by all_truth_hits(), all_truth_particles(), all_truth_showers(), do_caching(), and get_truth_jet().

CaloEvalStack JetTruthEval::_eemcevalstack
private

Definition at line 131 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 131 of file JetTruthEval.h

Referenced by do_caching(), get_eemc_eval_stack(), get_errors(), set_strict(), and set_verbosity().

unsigned int JetTruthEval::_errors = 0
private

Definition at line 138 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 138 of file JetTruthEval.h

Referenced by all_truth_hits(), all_truth_particles(), all_truth_showers(), get_errors(), get_truth_jet(), and ~JetTruthEval().

CaloEvalStack JetTruthEval::_femcevalstack
private

Definition at line 129 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 129 of file JetTruthEval.h

Referenced by do_caching(), get_errors(), get_femc_eval_stack(), next_event(), set_strict(), and set_verbosity().

CaloEvalStack JetTruthEval::_fhcalevalstack
private

Definition at line 130 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 130 of file JetTruthEval.h

Referenced by do_caching(), get_errors(), get_fhcal_eval_stack(), next_event(), set_strict(), and set_verbosity().

CaloEvalStack JetTruthEval::_hcalinevalstack
private

Definition at line 127 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 127 of file JetTruthEval.h

Referenced by do_caching(), get_errors(), get_hcalin_eval_stack(), next_event(), set_strict(), and set_verbosity().

CaloEvalStack JetTruthEval::_hcaloutevalstack
private

Definition at line 128 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 128 of file JetTruthEval.h

Referenced by do_caching(), get_errors(), get_hcalout_eval_stack(), next_event(), set_strict(), and set_verbosity().

bool JetTruthEval::_strict = false
private

Definition at line 136 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 136 of file JetTruthEval.h

Referenced by all_truth_hits(), all_truth_particles(), all_truth_showers(), get_truth_jet(), and set_strict().

SvtxEvalStack JetTruthEval::_svtxevalstack
private

Definition at line 125 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 125 of file JetTruthEval.h

Referenced by all_truth_hits(), do_caching(), get_errors(), get_svtx_eval_stack(), next_event(), set_strict(), set_track_nodename(), and set_verbosity().

PHG4TruthInfoContainer* JetTruthEval::_truthinfo = nullptr
private

Definition at line 133 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 133 of file JetTruthEval.h

Referenced by all_truth_particles(), get_node_pointers(), and get_truth_jet().

std::string JetTruthEval::_truthjetname
private

Definition at line 124 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 124 of file JetTruthEval.h

Referenced by get_node_pointers().

JetContainer* JetTruthEval::_truthjets = nullptr
private

Definition at line 134 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 134 of file JetTruthEval.h

Referenced by get_node_pointers(), and get_truth_jet().

int JetTruthEval::_verbosity = 1
private

Definition at line 137 of file JetTruthEval.h.

View newest version in sPHENIX GitHub at line 137 of file JetTruthEval.h

Referenced by set_verbosity(), and ~JetTruthEval().


The documentation for this class was generated from the following files: