Cs-137 Trapping App full pipeline by sophieehaight · Pull Request #284 · cositools/nuclearizer

sophieehaight · 2026-10-20T04:17:17Z

Standalone app which approximates experimental CCEs using Cs-137 calibration data and fits them to simulated CCE curves to obtain trapping parameters for each detector. The app requires energy, TAC, and depth calibration files as inputs in addition to the detector geometry and simulated CCE files. The final output is a csv file containing trapping parameters for all detectors for which data is read in. Additional plots and outputs characterizing goodness of fit are stored in folder trapping_param_products.

For instructions on usage enter "TrappingCorrectionCs137 -h".

Fixed style + formatting

fhagemann · 2026-10-20T20:21:47Z


  m_PixelCorrect = false;
-  m_MultiRoundStripPairing = false;
+  m_MultiRoundStripPairing = false; // should this be changed??


Is this a question for us or something to remind yourself?
My understanding is that we would use MModuleStripPairingMultiRoundChiSquare going forward (or at least that's the module that people have been updating recently).

fhagemann · 2026-10-20T20:23:34Z

+    return false;
+  }
+  m_ProductsPrefix = MString((ProductsDir / OutPath.filename()).string());
+  cout << "Intermediate products will be stored in " << ProductsDir.string() << endl;


you added some later cout statements into c_Info, but not here. Is this intended?

fhagemann · 2026-10-20T20:27:07Z

+  if (SimCCEs.empty()) {
+    std::cerr << "[FATAL] Simulated CCE file is empty or file not found at: " << g_SimulatedCCEPath << std::endl;
+    return false;
+  }


It seems like you're loading using namespace std; at the beginning of the file, so you could just remove std:: here and elsewhere:

Suggested change

if (SimCCEs.empty()) {

std::cerr << "[FATAL] Simulated CCE file is empty or file not found at: " << g_SimulatedCCEPath << std::endl;

return false;

}

if (SimCCEs.empty() == true) {

cerr << "[FATAL] Simulated CCE file is empty or file not found at: " << g_SimulatedCCEPath << endl;

return false;

}

fhagemann · 2026-10-20T20:27:55Z

+  if (!CombinedFile.is_open()) {
+    std::cerr << "[Error] Cannot create output file: " << CombinedCSV << std::endl;
+    return false;
+  }


I'm not going to flag everything, but maybe you can have a look for style guide changes:

Suggested change

if (!CombinedFile.is_open()) {

std::cerr << "[Error] Cannot create output file: " << CombinedCSV << std::endl;

return false;

}

if (CombinedFile.is_open() == false) {

cerr << "[Error] Cannot create output file: " << CombinedCSV << endl;

return false;

}

fhagemann · 2026-10-20T20:29:40Z

+  if (!Result.IsValid()) {
+    std::cerr << "[Warning] Fit result not valid (status " << Result.Status() << ") for Detector " << DetID << std::endl;
+  }


If you have warnings, you could do

Suggested change

if (!Result.IsValid()) {

std::cerr << "[Warning] Fit result not valid (status " << Result.Status() << ") for Detector " << DetID << std::endl;

}

if (Result.IsValid() == false) {

if (m_Verbosity >= c_Warning) cout << "WARNING: Fit result not valid (status " << Result.Status() << ") for Detector " << DetID << endl;

}

fhagemann · 2026-10-20T20:29:58Z

+  std::cout << "\n================ JOINT FIT RESULTS ================" << std::endl;
+  std::cout << "  Detector ID : " << DetID << std::endl;
+  std::cout << "  A_hv        : " << TrappingParams[0] << std::endl;
+  std::cout << "  A_lv        : " << TrappingParams[1] << std::endl;
+  std::cout << "  B (e-trap)  : " << TrappingParams[2] << std::endl;
+  std::cout << "  C (h-trap)  : " << TrappingParams[3] << std::endl;
+  std::cout << "  Chi2 (Calc) : " << CalculatedChi2 << std::endl;
+  std::cout << "  NDF         : " << NDF << std::endl;
+  std::cout << "  Chi2 / NDF  : " << (NDF > 0 ? CalculatedChi2 / NDF : -1) << std::endl;
+  std::cout << "====================================================\n" << std::endl;


Should this always be printed to the console?

fhagemann · 2026-10-20T20:32:39Z

+    Legend->Draw();
+  }
+
+  MString PlotFile = m_ProductsPrefix + MString("_Det_") + DetID + MString("_CCE_fit.png");


Do you always want to create PNG values for the CCE fits or should this be an optional feature that the user can turn off when running the app?

The module actually produces quite a lot of files characterizing the individual photopeak fits and fitted CCE. I had them read into a separate directory trapping_param_products to tuck them away. I can add an option s.t all output files apart from the trapping parameter file itself are suppressed unless you choose to save them.

I'll also wrap all of the terminal outputs in verbosity checks so that the outputs here are as clean as possible by default!

fixed compilation error, comment cleanup, updated verbosity settings

fhagemann · 2026-10-20T23:08:42Z

  double m_MaxEnergy;

-  //! Verbosity of this app's own output, independent of the MEGAlib g_Verbosity used by the nuclearizer modules
+  // Verbosity of this app's own output, independent of the globabl verbosity used by the nuclearizer modules


Typo:

Suggested change

// Verbosity of this app's own output, independent of the globabl verbosity used by the nuclearizer modules

// Verbosity of this app's own output, independent of the global verbosity used by the nuclearizer modules

fhagemann · 2026-10-20T23:09:54Z

  m_MaxEnergy = 700;
  m_NDepthBins = 20;
-  m_Verbosity = c_Error;
+  m_SaveProducts = false;


"Products" as in plots, or also the intermediate CCE files?
If it's both, we might want to have several independent options to save the CCE peak fit results, but not the plots, etc.

fhagemann · 2026-10-20T23:10:28Z

-        cout<<Usage.str()<<endl;
+      if (((argc > i+1) && (argv[i+1][0] != '-' || isalpha(argv[i+1][1]) == 0)) == false) {
+        if (m_Verbosity >= c_Error) {
+          cout<<"[Error] Option "<<argv[i][1]<<" needs a second argument!"<<endl;


We tend to use ERROR: Option ... syntax instead of [Error] Option ... but I don't have too strong of a feeling about this.

Yep happy to update these

fhagemann · 2026-10-20T23:11:29Z

+  // Relate the local verbosity setting to the global verbosity levels
+  if (m_Verbosity >= c_Info) {
+    gErrorIgnoreLevel = kInfo;
+  } else if (m_Verbosity >= c_Warning) {
+    gErrorIgnoreLevel = kWarning;
+  } else if (m_Verbosity >= c_Error) {
+    gErrorIgnoreLevel = kError;
+  } else {
+    gErrorIgnoreLevel = kFatal;
+  }


What's this needed for?

I'm wrapping the errors that ROOT outputs for the canvases and plots in this module with my verbosity settings for info, warning, and error so the ROOT errors only get printed at that verbosity setting. I updated the comment to clarify this.

fhagemann · 2026-10-20T23:12:30Z

    return false;
  }

+  // Check that you ond't trim too mnay depth bins


Suggested change

// Check that you ond't trim too mnay depth bins

// Check that you don't trim too many depth bins

fhagemann · 2026-10-20T23:12:55Z

    return false;
  }

+  // Set global verbosity to 0 s.t to supressed output from the nuclearizer modules 


Suggested change

// Set global verbosity to 0 s.t to supressed output from the nuclearizer modules

// Set global verbosity to 0 to suppress output from the nuclearizer modules

fhagemann · 2026-10-20T23:16:00Z

+  if (m_SaveProducts == true) {
+    PlotCCEFit(ExpData, Sim, TrappingParams, DetID);
+    SaveTrappingParamFile(OutputCSVPath, TrappingParamPath, TrappingParams, Sim, DetID);
+  }


Related to my comment above:
I would prefer having separate m_SaveProducts and m_SavePlots for the text files and plots of the fits, respectively.

Sounds good, I've update this in my next push. I've also added an option to save the hit and depth bin data in ROOT file after they've been calibrated by the nuclearizer modules. This separates the calibration step from the general analysis and ultimately makes it much quicker to fit experimental CCE at various binnings. Let me know what you think!

fhagemann · 2026-10-20T23:16:42Z

 ////////////////////////////////////////////////////////////////////////////////////////////////////

-void TrappingCorrectionCs137::PlotCCEFit(const std::vector<ExperimentalPoint>& ExpData,
+void TrappingCorrectionCs137::PlotCCEFit(const vector<ExperimentalPoint>& ExpData,


Can you attach an example screenshot of what such a PNG file would look like? :)

Here's one to show the formatting! could be a better fit though

updated comments

sophieehaight added 3 commits October 19, 2026 14:59

Added CCE fitting pipeline and trapping param generation

8132876

Fixed style & formatting

81e60f3

Fixed style + formatting

Added png plot of simulated and fitted CCE curves

4491395

sophieehaight force-pushed the trapping_app_pr branch from 805f82d to a7c23d4 Compare October 20, 2026 19:15

sophieehaight marked this pull request as ready for review October 20, 2026 19:16

sophieehaight assigned fhagemann and ckierans Oct 20, 2026

fhagemann reviewed Oct 20, 2026

View reviewed changes

Output + code cleanup

789d4be

fixed compilation error, comment cleanup, updated verbosity settings

sophieehaight force-pushed the trapping_app_pr branch from 2ed4928 to 789d4be Compare October 20, 2026 23:11

fhagemann reviewed Oct 20, 2026

View reviewed changes

sophieehaight added 4 commits October 20, 2026 16:57

Added plot output option

8256541

Option to save calibrated Cs data

30eb439

Comment Cleanup

7a8e9ec

updated comments

updated error message convention

4430f35

	// Verbosity of this app's own output, independent of the globabl verbosity used by the nuclearizer modules
	// Verbosity of this app's own output, independent of the global verbosity used by the nuclearizer modules

	// Check that you ond't trim too mnay depth bins
	// Check that you don't trim too many depth bins

	// Set global verbosity to 0 s.t to supressed output from the nuclearizer modules
	// Set global verbosity to 0 to suppress output from the nuclearizer modules

Conversation

sophieehaight commented Oct 20, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants