Skip to content

Per Plane Hit Tuning Parameters for GaussHitFinderSBN #626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
carriganm95 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Per Plane Hit Tuning Parameters for GaussHitFinderSBN #626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sbncode/CAFMaker/RecoUtils/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,6 @@ art_make_library( LIBRARY_NAME caf_RecoUtils
larsim::MCCheater_BackTrackerService_service
larsim::MCCheater_ParticleInventoryService_service
larcorealg::Geometry
sbnanaobj::StandardRecord
sbnanaobj::StandardRecordFlat
Comment on lines +14 to +15
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CMakeLists.txt changes add sbnanaobj StandardRecord dependencies, but these don't appear to be used by RecoUtils.cc or RecoUtils.h. Neither file includes or references StandardRecord or StandardRecordFlat. This change appears unrelated to the hit finder tuning described in the PR description. If these dependencies are needed for other purposes, that should be explained. If not, they should be removed as they add unnecessary dependencies and build-time coupling.

Copilot uses AI. Check for mistakes.
)
16 changes: 8 additions & 8 deletions sbncode/HitFinder/GaussHitFinderSBN_module.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@ namespace hit {
const std::vector<int> fLongMaxHitsVec; ///<Maximum number hits on a really long pulse train
const std::vector<int> fLongPulseWidthVec; ///<Sets width of hits used to describe long pulses

const size_t fMaxMultiHit; ///<maximum hits for multi fit
const std::vector<size_t> fMaxMultiHit; ///<maximum hits for multi fit
const int fAreaMethod; ///<Type of area calculation
const std::vector<double>
fAreaNormsVec; ///<factors for converting area to same units as peak height
const double fChi2NDF; ///maximum Chisquared / NDF allowed for a hit to be saved
const std::vector<double> fChi2NDF; ///maximum Chisquared / NDF allowed for a hit to be saved
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment formatting is inconsistent with surrounding code. The comment should use three slashes '///<' to match the style used for other member variable comments in this class (e.g., line 82).

Suggested change
const std::vector<double> fChi2NDF; ///maximum Chisquared / NDF allowed for a hit to be saved
const std::vector<double> fChi2NDF; ///<maximum Chisquared / NDF allowed for a hit to be saved

Copilot uses AI. Check for mistakes.

const std::vector<float> fPulseHeightCuts;
const std::vector<float> fPulseWidthCuts;
Expand Down Expand Up @@ -116,10 +116,10 @@ namespace hit {
, fLongMaxHitsVec(pset.get<std::vector<int>>("LongMaxHits", std::vector<int>() = {25, 25, 25}))
, fLongPulseWidthVec(
pset.get<std::vector<int>>("LongPulseWidth", std::vector<int>() = {16, 16, 16}))
, fMaxMultiHit(pset.get<int>("MaxMultiHit"))
, fMaxMultiHit(pset.get<std::vector<size_t>>("MaxMultiHitPerPlane", std::vector<size_t>() = {5, 5, 5}))
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The MaxMultiHitPerPlane parameter is not validated to ensure its size matches the number of planes in the geometry. Other similar parameters like AreaNorms use FillOutHitParameterVector to validate size and handle cases where the input vector has 1 element or N_PLANES elements. Without this validation, if a user provides a vector with an incorrect size, the code could fail at runtime with an out-of-bounds error when accessing fMaxMultiHit.at(plane). Consider using FillOutHitParameterVector or adding similar validation to ensure the vector size matches the geometry.

Copilot uses AI. Check for mistakes.
, fAreaMethod(pset.get<int>("AreaMethod"))
, fAreaNormsVec(FillOutHitParameterVector(pset.get<std::vector<double>>("AreaNorms")))
, fChi2NDF(pset.get<double>("Chi2NDF"))
, fChi2NDF(pset.get<std::vector<double>>("Chi2NDFPerPlane", std::vector<double>() = {500.0, 500.0, 500.0}))
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Chi2NDFPerPlane parameter is not validated to ensure its size matches the number of planes in the geometry. Other similar parameters like AreaNorms use FillOutHitParameterVector to validate size and handle cases where the input vector has 1 element or N_PLANES elements. Without this validation, if a user provides a vector with an incorrect size, the code could fail at runtime with an out-of-bounds error when accessing fChi2NDF.at(plane). Consider using FillOutHitParameterVector or adding similar validation to ensure the vector size matches the geometry.

Suggested change
, fChi2NDF(pset.get<std::vector<double>>("Chi2NDFPerPlane", std::vector<double>() = {500.0, 500.0, 500.0}))
, fChi2NDF(FillOutHitParameterVector(
pset.get<std::vector<double>>("Chi2NDFPerPlane",
std::vector<double>() = {500.0, 500.0, 500.0})))

Copilot uses AI. Check for mistakes.
, fPulseHeightCuts(
pset.get<std::vector<float>>("PulseHeightCuts", std::vector<float>() = {3.0, 3.0, 3.0}))
, fPulseWidthCuts(
Expand Down Expand Up @@ -365,13 +365,13 @@ namespace hit {
// #######################################################
// ### If # requested Gaussians is too large then punt ###
// #######################################################
if (mergedCands.size() <= fMaxMultiHit) {
if (mergedCands.size() <= fMaxMultiHit.at(plane)) {
fPeakFitterTool->findPeakParameters(
range.data(), mergedCands, peakParamsVec, chi2PerNDF, NDF);

// If the chi2 is infinite then there is a real problem so we bail
if (!(chi2PerNDF < std::numeric_limits<double>::infinity())) {
chi2PerNDF = 2. * fChi2NDF;
chi2PerNDF = 2. * fChi2NDF.at(plane);
NDF = 2;
}

Expand All @@ -384,7 +384,7 @@ namespace hit {
// ### depend on the fhicl parameter fLongPulseWidth ###
// ### Also do this if chi^2 is too large ###
// #######################################################
if (mergedCands.size() > fMaxMultiHit || nGausForFit * chi2PerNDF > fChi2NDF) {
if (mergedCands.size() > fMaxMultiHit.at(plane) || nGausForFit * chi2PerNDF > fChi2NDF.at(plane)) {
int longPulseWidth = fLongPulseWidthVec.at(plane);
int nHitsThisPulse = (endT - startT) / longPulseWidth;

Expand All @@ -401,7 +401,7 @@ namespace hit {
peakParamsVec.clear();
nGausForFit = nHitsThisPulse;
NDF = 1.;
chi2PerNDF = chi2PerNDF > fChi2NDF ? chi2PerNDF : -1.;
chi2PerNDF = chi2PerNDF > fChi2NDF.at(plane) ? chi2PerNDF : -1.;

for (int hitIdx = 0; hitIdx < nHitsThisPulse; hitIdx++) {
// This hit parameters
Expand Down
26 changes: 14 additions & 12 deletions sbncode/HitFinder/hitfindermodules_sbn.fcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,19 @@ gauss_hitfinder:
{
module_type: "GaussHitFinderSBN"
CalDataModuleLabel: "caldata"
MaxMultiHit: 5 # maximum hits for multi gaussia fit attempt
AreaMethod: 0 # 0 = area by integral, 1 = area by gaussian area formula
AreaNorms: [ 1.0, 1.0, 1.0 ] # normalizations that put signal area in
# same scale as peak height.
TryNplus1Fits: false # Don't try to refit with extra peak if bad chisq
LongMaxHits: [ 25, 25, 25] # max number hits in long pulse trains
LongPulseWidth: [ 10, 10, 10] # max widths for hits in long pulse trains
Chi2NDF: 500. # maximum Chisquared / NDF allowed to store fit, if fail
# will use "long" pulse method to return hit
AllHitsInstanceName: "" # If non-null then this will be the instance name of all hits output to event
# in this case there will be two hit collections, one filtered and one containing all hits
MaxMultiHit: 5 # maximum hits for multi gaussian fit attempt
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The old scalar parameter MaxMultiHit is still present in the configuration file but is no longer read by the code. The code now only reads MaxMultiHitPerPlane. This parameter should be removed to avoid confusion and maintain consistency, as it no longer has any effect on the module's behavior.

Suggested change
MaxMultiHit: 5 # maximum hits for multi gaussian fit attempt

Copilot uses AI. Check for mistakes.
MaxMultiHitPerPlane: [ 10, 10, 8 ] # maximum hits per plane for multi gaussia fit attempt
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling error in comment: "gaussia" should be "gaussian".

Suggested change
MaxMultiHitPerPlane: [ 10, 10, 8 ] # maximum hits per plane for multi gaussia fit attempt
MaxMultiHitPerPlane: [ 10, 10, 8 ] # maximum hits per plane for multi gaussian fit attempt

Copilot uses AI. Check for mistakes.
AreaMethod: 0 # 0 = area by integral, 1 = area by gaussian area formula
AreaNorms: [ 1.0, 1.0, 1.0 ] # normalizations that put signal area in
# same scale as peak height.
TryNplus1Fits: false # Don't try to refit with extra peak if bad chisq
LongMaxHits: [ 25, 25, 25] # max number hits in long pulse trains
LongPulseWidth: [ 5, 5, 5] # max widths for hits in long pulse trains
Chi2NDF: 500. # maximum Chisquared / NDF allowed to store fit
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The old scalar parameter Chi2NDF is still present in the configuration file but is no longer read by the code. The code now only reads Chi2NDFPerPlane. This parameter should be removed to avoid confusion and maintain consistency, as it no longer has any effect on the module's behavior.

Suggested change
Chi2NDF: 500. # maximum Chisquared / NDF allowed to store fit

Copilot uses AI. Check for mistakes.
Chi2NDFPerPlane: [ 2500., 1750., 2500.] # maximum Chisquared / NDF allowed per plane to store, if fail
# will use "long" pulse method to return hit
AllHitsInstanceName: "" # If non-null then this will be the instance name of all hits output to event
# in this case there will be two hit collections, one filtered and one containing all hits

# Candididate peak finding done by tool, one tool instantiated per plane (but could be other divisions too)
HitFinderToolVec:
Expand All @@ -39,7 +41,7 @@ gauss_hitfinder:
HitFilterAlg:
{
AlgName: "HitFilterAlg"
MinPulseHeight: [5.0, 5.0, 5.0] #minimum hit peak amplitude per plane
MinPulseHeight: [2.0, 2.0, 2.0] #minimum hit peak amplitude per plane
MinPulseSigma: [1.0, 1.0, 1.0] #minimum hit rms per plane
}
# In addition to the filter alg we can also filter hits on the same pulse train
Expand Down
Loading