Pawel plesniak/absorber shift

[PawelPlesniak]

This PR addresses several issues found when completing the corrections to my normalization studies.

Changes are summarized in the bullet point list for each file affected by core code changes. Critically note - there are several other files that are also affected, but the pre-commit config highlighted many changes that needed to happen before my changes could go in (after rebasing with branch main). These changes have been addressed.

• CountVirtualDetectorHits_module.cc - this makes the vector of virtual detectors being summarized in the model unique, my mapping to and back from an unordered set
• PhotonGun_module.cc - this now allows for a set of photons to travel in a straight line from the origin to target position, defined by a direction vector as delta_x, delta_y, and delta_z. This vector is mapped to the unit vector, and the momentum is scaled accordingly.
• AbsorberFromSTHPGe.fcl - driver code that will allow future unfolding studies to be performed, especially important for the HPGe where additional absorber is present, and the results have not yet been fully quantified.
• AbsorberFromSTLaBr.fcl - as above but for LaBr.
• EventFilter.fcl - debugging tool to help with ongoing simulation studies. Allows for looking at individual events in a data file. For my studies, it was used to demonstrate the behaviour of the ZS and MWD algorithms on a macro-spill worth of beam-on time.
• FirePhotonToDetector.fcl - driver code that fires singular photons to a detector of choice, aimed for use with studying the STM detector waveform generators and analysis tools.
• STMMC/fcl/prolog.fcl - rewritten to define the simulation parameters more clearly
• ROOTAnalysisDump.fcl - driver code to convert the art files into ROOT format for easy plotting. I will not be rewriting this for the current analysis framework as I do not have the time for this.
• HPGeWaveformsFromStepPointMCs_module.cc - addresses issues with the waveform generator, namely
  • MWD was failing with this implementation as the waveform amplitudes were set to zero during microspills that did not have photons interacting with the detector crystal, throwing off MWD
  • Concatenated events were discontinuous
  • Added preamplifier charge collection response function
• SimParticleAndVDBacktrace_module.cc - new module generating ROOT files with data that backtraces of STM signal photons back through the SimParticle provenance. The code to plot these will be merged in the STMAnalysis repository
• SimParticleDump_module.cc - dumps the full SimParticle provenance to ROOT files for plotting, with a more compact format than the previous module.
• STMResamplingProducer_module.cc - Initial simulations had different data product names for SimParticles propagated with the BeamToVD and BeamToVD1809 drivers, this change standardizes them.
• VirtualDetectorTree_module.cc - add more data to ROOT files generated for plotting.
• STMMovingWindowDeconvolution_module.cc - some more data for visualizing the behaviour of analyzed waveforms

I would like to ask some questions

• Why was the STMMWDDigi renamed to STMPHDigi, and what is the difference in analysis chains?

[FNALbuild]

Hi @PawelPlesniak,
You have proposed changes to files in these packages:

• STMMC
• STMReco
• Analyses
• EventGenerator
• RecoDataProducts

which require these tests: build.

@Mu2e/write, @Mu2e/fnalbuild-users have access to CI actions on main.

⌛ The following tests have been triggered for 3bb3d47: build (Build queue - API unavailable)

About FNALbuild. Code review on Mu2e/Offline.

[FNALbuild]

‼️ It was not possible to prepare the workspace for this test. This is often caused by merge conflicts - please check and try again.

> git diff --check | grep -i conflict
EventGenerator/src/PhotonGun_module.cc:69: leftover conflict marker
EventGenerator/src/PhotonGun_module.cc:71: leftover conflict marker
EventGenerator/src/PhotonGun_module.cc:74: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:21: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:29: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:40: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:48: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:53: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:56: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:64: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:66: leftover conflict marker
RecoDataProducts/inc/STMWaveformDigi.hh:68: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:66: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:70: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:76: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:84: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:86: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:88: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:101: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:104: leftover conflict marker
STMMC/fcl/HPGeWaveformGenerationAndAnalysis.fcl:109: leftover conflict marker
STMMC/fcl/prolog.fcl:158: leftover conflict marker
STMMC/fcl/prolog.fcl:160: leftover conflict marker
STMMC/fcl/prolog.fcl:162: leftover conflict marker
STMMC/fcl/prolog.fcl:174: leftover conflict marker
STMMC/fcl/prolog.fcl:178: leftover conflict marker
STMMC/fcl/prolog.fcl:188: leftover conflict marker
STMReco/src/STMMovingWindowDeconvolution_module.cc:118: leftover conflict marker
STMReco/src/STMMovingWindowDeconvolution_module.cc:120: leftover conflict marker
STMReco/src/STMMovingWindowDeconvolution_module.cc:130: leftover conflict marker
STMReco/src/STMMovingWindowDeconvolution_module.cc:317: leftover conflict marker
STMReco/src/STMMovingWindowDeconvolution_module.cc:326: leftover conflict marker
STMReco/src/STMMovingWindowDeconvolution_module.cc:330: leftover conflict marker

Test	Result	Details
test with	✅	Command did not list any other PRs to include
merge	❌	3bb3d47 into 704459c merge failed

[PawelPlesniak]

I leave this for review by @YongyiBWu and @AndrewEdmonds11

[PawelPlesniak]

Note - I will review any failures that the CI workflow raises

[PawelPlesniak]

@FNALbuild run build test

[FNALbuild]

⌛ The following tests have been triggered for b19652b: build (Build queue - API unavailable)

[FNALbuild]

☔ The build is failing at b19652b.

scons: *** [build/al9-prof-e29-p101/Offline/tmp/STMReco/src/STMMovingWindowDeconvolution_module.os] Error 1

Test	Result	Details
test with	✅	Command did not list any other PRs to include
merge	✅	Merged b19652b at 8a343bd
build (prof)	❌	Log file.
ceSimReco	〰️	Log file.
g4test_03MT	〰️	Log file.
transportOnly	〰️	Log file.
POT	〰️	Log file.
g4study	〰️	Log file.
cosmicSimReco	〰️	Log file.
cosmicOffSpill	〰️	Log file.
ceSteps	〰️	Log file.
ceDigi	〰️	Log file.
muDauSteps	〰️	Log file.
ceMix	〰️	Log file.
rootOverlaps	〰️	Log file.
g4surfaceCheck	〰️	Log file.
trigger	❗	Log file.
check_cmake	〰️	Log file.
FIXME, TODO	➡️	TODO (8) FIXME (1) in 19 files
clang-tidy	➡️	30 errors 265 warnings
whitespace check	✅	no whitespace errors found

N.B. These results were obtained from a build of this Pull Request at b19652b after being merged into the base branch at 8a343bd.

For more information, please check the job page here.
Build artifacts are deleted after 5 days. If this is not desired, select Keep this build forever on the job page.

[PawelPlesniak]

@FNALbuild run build test

[FNALbuild]

⌛ The following tests have been triggered for 7463724: build (Build queue - API unavailable)

[FNALbuild]

☀️ The build tests passed at 7463724.

Test	Result	Details
test with	✅	Command did not list any other PRs to include
merge	✅	Merged 7463724 at 8a343bd
build (prof)	✅	Log file. Build time: 04 min 17 sec
ceSimReco	✅	Log file.
g4test_03MT	✅	Log file.
transportOnly	✅	Log file.
POT	✅	Log file.
g4study	✅	Log file.
cosmicSimReco	✅	Log file.
cosmicOffSpill	✅	Log file.
ceSteps	✅	Log file.
ceDigi	✅	Log file.
muDauSteps	✅	Log file.
ceMix	✅	Log file.
rootOverlaps	✅	Log file.
g4surfaceCheck	✅	Log file.
trigger	✅	Log file.
check_cmake	✅	Log file.
FIXME, TODO	➡️	TODO (8) FIXME (1) in 19 files
clang-tidy	➡️	28 errors 267 warnings
whitespace check	✅	no whitespace errors found

N.B. These results were obtained from a build of this Pull Request at 7463724 after being merged into the base branch at 8a343bd.

For more information, please check the job page here.
Build artifacts are deleted after 5 days. If this is not desired, select Keep this build forever on the job page.

[PawelPlesniak]

@YongyiBWu and @AndrewEdmonds11 The CI workflow issues have been addressed, this is now ready for review