Store observed sync tagger to BXCounterSync CDB TTree for use in EBDC which failed BXSync by blackcathj · Pull Request #4301 · sPHENIX-Collaboration/coresoftware

blackcathj · 2026-06-14T11:58:21Z

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work for users)
Requiring change in macros repository (Please provide links to the macros pull request in the last section)
I am a member of GitHub organization of sPHENIX Collaboration, EIC, or ECCE (contact Chris Pinkenburg to join)

What kind of change does this PR introduce? (Bug fix, feature, ...)

This deals a rare problem in TPC data that was identified in the last iteration of production: some time the beam crossing clock sync tagger (BX_COUNTER_SYNC_T) which record the time when the FEE clock is reset. BX_COUNTER_SYNC_T is used to predict the synchronization of FEE to sPHENIX clock, without which the event building does not work reliably. This tagger is identical cross 48 independent TPC data streams.

This PR introduce storing BX_COUNTER_SYNC_T to CDB file by default. Then this CDB file can be used to recover the rare cases for one of the 48 TPC data stream missing this tagger.

How to use

The output CDB file is available after the first event execution and save out at the end of Fun4All macro by default such as

void TpcTimeFrameBuilderRun3::write_bx_counter_sync_cdb_tree() const - saved 26 BX_COUNTER_SYNC_T observations to TpcTimeFrameBuilderRun3_Packet4110_BXCounterSyncCDBTTree.root

And the location can be over written with

      SingleTpcTimeFrameInput *tpc_sngl = new SingleTpcTimeFrameInput("SingleTpcTimeFrameInput_" + to_string(i));
      tpc_sngl->setBXCounterSyncCDBTTreeName(iter + "_BXCounterSyncCDBTTree.root");

TODOs (if applicable)

Add the read function with a problematic run is identified and its CDB file installed.

Links to other PRs in macros and calibration repositories (if applicable)

#4292

BX Counter Sync Observation CDB Storage

Motivation

During TPC data production, the beam crossing counter sync tagger (BX_COUNTER_SYNC_T) occasionally goes missing from one of the 48 independent TPC data streams. This tagger records the FEE clock reset time and is critical for predicting FEE-to-sPHENIX master clock synchronization. When missing from any stream, event building becomes unreliable. This PR implements automated capture of these synchronization observations to enable recovery in affected runs.

Key Changes

TpcTimeFrameBuilderRun3: Captures the first 4 BX_COUNTER_SYNC_T observations per FEE (stored in BXCounterSyncObservation records) with associated GTM and reference BCO values, fixed clock offsets (GTM: 0, FEE: 12)
CDB Output: Writes observations to a CDBTTree file with per-FEE records indexed as channels, storing packet ID, FEE, observation count, and metadata
Default Behavior: Automatically generates CDB files with naming pattern TpcTimeFrameBuilderRun3_Packet<id>_BXCounterSyncCDBTTree.root after first event execution
API: Added setBXCounterSyncCDBTTreeName() on SingleTpcTimeFrameInput to customize output location; defaults to empty string (no-op on base class)
Virtual Interface: Extended TpcTimeFrameBuilderBase with pure virtual SaveBXCounterSyncCDBTTree() method; implemented in TpcTimeFrameBuilderRun3, empty stub in TpcTimeFrameBuilder

Potential Risk Areas

IO Changes: New CDB files generated automatically; disk space implications for repeated data collection
Data Storage Design: Storage limited to 4 observations per FEE and per packet builder; exceeding this limit silently discards additional observations—verify this cap is sufficient for production use cases
Clock Synchronization Dependencies: Uses fixed hardcoded offsets for GTM and FEE BCO; any hardware or FEE changes may require offset recalibration
CDB Integration: Production readiness depends on CDB installation infrastructure; no read-back function implemented yet (deferred to future iteration per PR notes)

Possible Future Improvements

Implement read-back functionality to reconstruct missing taggers using stored CDB observations
Increase observation storage limit or implement dynamic allocation
Add configurable BCO offsets for different hardware configurations
Monitor observation capture statistics and alert on insufficient synchronization events

… which failed BXSync

coderabbitai · 2026-06-14T11:58:37Z

📝 Walkthrough

Walkthrough

A new SaveBXCounterSyncCDBTTree method is propagated through the TpcTimeFrameBuilderBase pure-virtual interface, a no-op override in TpcTimeFrameBuilder, and a full implementation in TpcTimeFrameBuilderRun3. The Run3 builder records BX_COUNTER_SYNC_T observations inside BcoMatchingInformation and writes them to a CDBTTree file on destruction. SingleTpcTimeFrameInput is extended with a setter and a conditional call in FillPool.

Changes

BX Counter Sync CDB TTree persistence

Layer / File(s)	Summary
Base interface and TpcTimeFrameBuilder no-op stub `offline/framework/fun4allraw/TpcTimeFrameBuilderBase.h`, `offline/framework/fun4allraw/TpcTimeFrameBuilder.h`, `offline/framework/fun4allraw/TpcTimeFrameBuilder.cc`	`TpcTimeFrameBuilderBase` adds `SaveBXCounterSyncCDBTTree` as a new pure-virtual method; `TpcTimeFrameBuilder` declares and provides an empty override stub.
BcoMatchingInformation observation data structures and recording `offline/framework/fun4allraw/TpcTimeFrameBuilderRun3.h`, `offline/framework/fun4allraw/TpcTimeFrameBuilderRun3.cc`	Introduces `BXCounterSyncObservation` struct, `kMaxBXCounterSyncObservations` limit, accessors, member storage, and `save_bx_counter_sync_observation` helper in `BcoMatchingInformation`; updates `save_gtm_bco_information` to construct the reference pair and record an observation when `modebits == BX_COUNTER_SYNC_T`.
Run3 CDB TTree write-out lifecycle `offline/framework/fun4allraw/TpcTimeFrameBuilderRun3.h`, `offline/framework/fun4allraw/TpcTimeFrameBuilderRun3.cc`	Adds `m_bxCounterSyncCDBTTreeName` and `write_bx_counter_sync_cdb_tree`; constructor sets a default filename, destructor triggers the write, public setter `SaveBXCounterSyncCDBTTree` stores the configured name, and `write_bx_counter_sync_cdb_tree` populates and commits a `CDBTTree` from accumulated observations.
SingleTpcTimeFrameInput FillPool wiring `offline/framework/fun4allraw/SingleTpcTimeFrameInput.h`, `offline/framework/fun4allraw/SingleTpcTimeFrameInput.cc`	Adds `setBXCounterSyncCDBTTreeName` setter and `m_bxCounterSyncCDBTTreeName` member; `FillPool` conditionally calls `SaveBXCounterSyncCDBTTree` on each packet builder when the name is non-empty.

Possibly related PRs

sPHENIX-Collaboration/coresoftware#4292: Introduced the Run3-specific TpcTimeFrameBuilderRun3 and BcoMatchingInformation logic on which the new BX_COUNTER_SYNC_T observation recording and SaveBXCounterSyncCDBTTree implementation directly build.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e07f3266-0853-4fb3-a896-7a48b64bd656

📥 Commits

Reviewing files that changed from the base of the PR and between c723a58 and da627ac.

📒 Files selected for processing (7)

offline/framework/fun4allraw/SingleTpcTimeFrameInput.cc
offline/framework/fun4allraw/SingleTpcTimeFrameInput.h
offline/framework/fun4allraw/TpcTimeFrameBuilder.cc
offline/framework/fun4allraw/TpcTimeFrameBuilder.h
offline/framework/fun4allraw/TpcTimeFrameBuilderBase.h
offline/framework/fun4allraw/TpcTimeFrameBuilderRun3.cc
offline/framework/fun4allraw/TpcTimeFrameBuilderRun3.h

sphenix-jenkins-ci · 2026-06-14T15:21:43Z

Build & test report

Report for commit da627ac20bdbc5b0542d6d12503c1f00f6d0f3cd:

builds and tests overall are SUCCESS.
Build with configuration of alma9.2-gcc-14.2.0 / clang is SUCCESS, 📊clang report (full)/(new), build log
Build with configuration of alma9.2-gcc-14.2.0 / new is SUCCESS, 📊Compiler report (full)/(new), build log
- Generating DST and readback: build is SUCCESS
- Calorimeter QA: build is SUCCESS, 📊 trends
  - 📊 QA-calorimeter for e- at p_T=4GeV : combined Chi2/nDoF = 27.45 / 72, and combined p-Value = 1
  - 📊 QA-calorimeter for pi+ at p_T=30GeV : combined Chi2/nDoF = 41.6183 / 72, and combined p-Value = 0.998442
  - 📊 QA-calorimetric-jet for e- at p_T=4GeV : combined Chi2/nDoF = 0.4559 / 42, and combined p-Value = 1
  - 📊 QA-calorimetric-jet for pi+ at p_T=30GeV : combined Chi2/nDoF = 14.2531 / 42, and combined p-Value = 0.999981
- Tracking QA with Distortions: build is SUCCESS, 📊 trends
  - 📊 QA-distortions
- Tracking QA at low occupancy: build is SUCCESS, 📊 trends
  - 📊 QA-Intt : combined Chi2/nDoF = -0 / 72, and combined p-Value = 1
  - 📊 QA-Micromegas : combined Chi2/nDoF = -0 / 20, and combined p-Value = 1
  - 📊 QA-Mvtx : combined Chi2/nDoF = -0 / 54, and combined p-Value = 1
  - 📊 QA-Tpc : combined Chi2/nDoF = -0 / 56, and combined p-Value = 1
  - 📊 QA-tracking : combined Chi2/nDoF = 15.7576 / 56, and combined p-Value = 1
  - 📊 QA-vertexing : combined Chi2/nDoF = 39.0875 / 112, and combined p-Value = 1
- Tracking QA for Pythia D0-jet: build is SUCCESS, 📊 trends
  - 📊 QA-Intt : combined Chi2/nDoF = -0 / 72, and combined p-Value = 1
  - 📊 QA-Micromegas : combined Chi2/nDoF = -0 / 20, and combined p-Value = 1
  - 📊 QA-Mvtx : combined Chi2/nDoF = -0 / 54, and combined p-Value = 1
  - 📊 QA-Tpc : combined Chi2/nDoF = -0 / 56, and combined p-Value = 1
  - 📊 QA-tracking : combined Chi2/nDoF = 6.36278 / 50, and combined p-Value = 1
  - 📊 QA-vertexing : combined Chi2/nDoF = 37.13 / 112, and combined p-Value = 1
- Tracking QA from run2pp 53877: build is SUCCESS, 📊 trends
  - 📊 QA-intt : combined Chi2/nDoF = -0 / 18, and combined p-Value = 1
  - 📊 QA-micromegas : combined Chi2/nDoF = -0 / 6, and combined p-Value = 1
  - 📊 QA-mvtx : combined Chi2/nDoF = -0 / 18, and combined p-Value = 1
  - 📊 QA-siliconseeds : combined Chi2/nDoF = -0 / 20, and combined p-Value = 1
  - 📊 QA-tpc : combined Chi2/nDoF = -0 / 48, and combined p-Value = 1
  - 📊 QA-tpcseeds : combined Chi2/nDoF = -0 / 28, and combined p-Value = 1
  - 📊 QA-trackfit : combined Chi2/nDoF = -0 / 32, and combined p-Value = 1
- system alma9.2-gcc-14.2.0, build new: run the default sPHENIX macro: build is SUCCESS, output, trends 📊
- system alma9.2-gcc-14.2.0, build new: run the default CaloProduction/Fun4All_Year2.C macro: build is SUCCESS, output, trends 📊
- system alma9.2-gcc-14.2.0, build new: run the default StreamingProduction/Fun4All_Stream_Combiner.C macro: build is SUCCESS, output, trends 📊
- system alma9.2-gcc-14.2.0, build new: Valgrind test of CaloProduction/Fun4All_Year2.C: build is SUCCESS, 📊valgrind report, trends 📊
- system alma9.2-gcc-14.2.0, build new: Valgrind test of StreamingProduction/Fun4All_Stream_Combiner.C: build is SUCCESS, 📊valgrind report, trends 📊
- system alma9.2-gcc-14.2.0, build new: run the overlap check for sPHENIX macro: build is SUCCESS, output
- system alma9.2-gcc-14.2.0, build new: Valgrind test: build is SUCCESS, 📊valgrind report, trends 📊
Build with configuration of alma9.2-gcc-14.2.0 / scan is SUCCESS, 📊scan-build report (full)/(new), build log
clang-tidy is SUCCESS, 📊clang-tidy report (full)/(new)
cpp-check is SUCCESS, 📊cppcheck report (full)/(new)