eic-opticks/u4/U4Debug.hh

0001 #pragma once
0002
0003 /**
0004 U4Debug.hh : Umbrella struct for coordinated saving of debug arrays
0005 =====================================================================
0006
0007 The below debug structs were developed to investigate issues such as a lack of gensteps.
0008 As these structs are used purely for debug, not monitoring, usage is typically
0009 hidden behind the WITH_G4CXOPTICKS_DEBUG preprocessor macro, which is not normally active.
0010
0011 U4Cerenkov_Debug
0012    records detailed debug info for cerenkov steps
0013    collected for example from G4Cerenkov_modified::PostStepDoIt
0014
0015 U4Scintillation_Debug
0016    records detailed debug info for scintillation steps
0017    collected for example from DsG4Scintillation::PostStepDoIt shortly before the
0018
0019 U4Hit_Debug
0020    records photon spho labels of hits with gs indices
0021    collected for example from junoSD_PMT_v2::SaveNormHit/junoSD_PMT_v2::ProcessHits
0022
0023
0024 To make the connection between the debug steps and labels ?
0025 Is not so simple because the purposes are different.
0026 Want to record steps that yield no gensteps in order to
0027 understand lack of gensteps.
0028
0029 **/
0030
0031
0032 #include "plog/Severity.h"
0033 #include "U4_API_EXPORT.hh"
0034
0035 struct U4_API U4Debug
0036 {
0037     static const plog::Severity LEVEL ;
0038     static constexpr const char* ETOK = "${U4Debug_SaveDir:-$TMP}/U4Debug" ;  // see spath::ResolveToken
0039     //static const char* SaveDir ;
0040     //static const char* GetSaveDir(int eventID);
0041
0042     static void Save(int eventID);
0043 };
0044
0045
0046
0047