interface SPEArea DB with ophit recalibrator

Author: mvicenzi

fcl/reco/Definitions/stage0_icarus_defs.fcl

@@ -12,7 +12,7 @@
 #include "timing_icarus.fcl"
 #include "timing_beam.fcl"
 #include "icarus_ophitfinder.fcl"
-#include "ophit-recalibrator.fcl"
+#include "ophit_recalibrator_icarus.fcl"
 #include "icarus_flashfinder.fcl"
 #include "trigger_emulation_icarus.fcl"
 #include "crt_decoderdefs_icarus.fcl"

fcl/reco/Stage0/partial/stage0_run2_opdetonly_icarus_data_reprocessing.fcl

@@ -27,10 +27,9 @@ physics.path: [
 
 # recalibrate optical hits
 physics.producers.ophit.InputLabel: "ophit::stage0"  # start from hits in previous stage0 execution
-physics.producers.ophit.RecalibratePE: true           # recalibrate PE values
-physics.producers.ophit.UseGainDatabase: false        # not ready yet
-physics.producers.ophit.SPEArea: @local::SPERun2.Area # use fixed value for all channels
-physics.producers.ophit.RecalibrateTime: false        # not needed for Run2
+physics.producers.ophit.RecalibratePE: true          # recalibrate PE values
+physics.producers.ophit.UseGainDatabase: true        # speArea db
+physics.producers.ophit.RecalibrateTime: false       # not needed for Run2
 
 # make sure flashes are using the new ophits
 # as well as the correct (non)calibration

fcl/reco/Stage0/partial/stage0_run3_opdetonly_icarus_data_reprocessing.fcl

@@ -1,12 +1,7 @@
 #include "stage0_run2_opdetonly_icarus_data_reprocessing.fcl"
 
-# recalibrate optical hits
-physics.producers.ophit.RecalibratePE: true           # recalibrate PE values
-physics.producers.ophit.UseGainDatabase: false        # not ready yet
-physics.producers.ophit.SPEArea: @local::SPERun4.Area # use fixed value for all channels
-
 physics.producers.ophit.RecalibrateTime: true         # also needed for Run4
 # these were the tags used in the initial data processing (v10_06_00_01p05)
 physics.producers.ophit.OldTimingDBTags.CablesTag:  @local::PMT_CalibrationTags_Run3_Feb2025.pmt_cables_delays_data
 physics.producers.ophit.OldTimingDBTags.LaserTag:   @local::PMT_CalibrationTags_Run3_Feb2025.pmt_laser_timing_data
-physics.producers.ophit.OldTimingDBTags.CosmicsTag: @local::PMT_CalibrationTags_Run3_Feb2025.pmt_cosmics_timing_data
+physics.producers.ophit.OldTimingDBTags.CosmicsTag: @local::PMT_CalibrationTags_Run3_Feb2025.pmt_cosmics_timing_data

fcl/reco/Stage0/partial/stage0_run4_opdetonly_icarus_data_reprocessing.fcl

@@ -56,6 +56,8 @@ namespace calib {
 
     ICARUSPhotonCalibratorServiceFromDB(Parameters const& params, art::ActivityRegistry& reg);
 
+    virtual std::string getAreaDatabaseTag() const = 0;
+
   private:
     provider_type const* provider() const override { return &fProvider; }
 

icaruscode/PMT/Calibration/ICARUSPhotonCalibratorServiceFromDB.h

@@ -9,6 +9,7 @@
 #include "icaruscode/Timing/PMTTimingCorrections.h"
 #include "icaruscode/Timing/IPMTTimingCorrectionService.h"
 #include "icaruscode/Timing/PMTTimingCorrectionsProvider.h"
+#include "icaruscode/PMT/Calibration/ICARUSPhotonCalibratorServiceFromDB.h"
 
 // framework libraries
 #include "canvas/Utilities/InputTag.h"
@@ -45,25 +46,25 @@ namespace icarus
  * gain and/or timing calibrations, and applies new ones.
  * A new collection of hits is produced containing a re-calibrated copy of all the
  * hits from the input collections.
- * 
- * The PE recalibration is simple: for each optical hit, its `PE` value is recomputed 
+ *
+ * The PE recalibration is simple: for each optical hit, its `PE` value is recomputed
  * from its `Area` [ADC x tick] based on a newly determined single-PE area.
  * If `UseGainDatabase` is set, the module calls retrieves the SPE area by channel and run number
- * using the gain calibration service. If that option is disabled, a single SPE area value 
+ * using the gain calibration service. If that option is disabled, a single SPE area value
  * is used for all channels and run numbers. This value is read from the `SPEArea` paramater
  * set in the configuration.
- * 
- * The timing recalibration requires removing previously-applied timing corrections and 
- * adding the new ones. Unfortunately, however, it's not possible to easily determine 
+ *
+ * The timing recalibration requires removing previously-applied timing corrections and
+ * adding the new ones. Unfortunately, however, it's not possible to easily determine
  * which timing corrections were previsouly applied to the optical hits.
  * The old corrections -- that need to be removed -- are therefore obtained by locally
- * definining an instance of `icarusDB::PMTTimingCorrectionsProvider` and manually setting 
+ * definining an instance of `icarusDB::PMTTimingCorrectionsProvider` and manually setting
  * in the configuration the database tags that were used originally (`OldTimingDBTags`).
  * These need to be deduced by the `icaruscode` version that was used and the corresponding
  * settings in `calibration_database_GlobalTags_icarus.fcl`
  * On the other hand, the new corrections are obtained from the current timing correction
  * service `icarusDB::PMTTimingCorrections` as defined in `timing_icarus.fcl`.
- * 
+ *
  * Input
  * ------
  * * `std::vector<recob::OpHit>` data products (as for `InputLabels`)
@@ -83,9 +84,9 @@ namespace icarus
  * * `SPEArea` (double, default: -1): if not using the gain database, single-photoelectron
  *    area in ADC x tick to be used in the PE calibration.
  * * `RecalibrateTime` (flag, mandatory): if set, recalibrate hit times.
- * * `OldTimingDBTags` (fhicl::ParameterSet, mandatory): configuration for the previously-applied timing corrections 
+ * * `OldTimingDBTags` (fhicl::ParameterSet, mandatory): configuration for the previously-applied timing corrections
  *    that need to be removed/replace by the now ones. It should match what is tipically passed to
- *    `icarusDB::PMTTimingCorrectionsProvider`, specifying the database tags that were used. 
+ *    `icarusDB::PMTTimingCorrectionsProvider`, specifying the database tags that were used.
  * * `Verbose` (flag, default: `false`): verbose printing
  *
  */
@@ -108,10 +109,11 @@ class icarus::OpHitRecalibrator : public art::SharedProducer
     bool const fRecalibrateTime;
     bool const fUseGainDatabase;
     double const fSPEArea;
-    bool const fVerbose; 
+    bool const fVerbose;
 
-    /// Pointer to the online pmt corrections service
+    /// Pointers to the online corrections services
     icarusDB::PMTTimingCorrections const &fPMTTimingCorrectionsService;
+    icarusDB::PhotonCalibratorFromDB const &fPhotonCalibratorService;
 
     /// Pointer to the provider for the old pmt corrections
     std::unique_ptr<icarusDB::PMTTimingCorrectionsProvider> fOldTimingProvider;
@@ -127,6 +129,7 @@ icarus::OpHitRecalibrator::OpHitRecalibrator(fhicl::ParameterSet const &config,
       fSPEArea{config.get<double>("SPEArea", -1.)},
       fVerbose{config.get<bool>("Verbose", false)},
       fPMTTimingCorrectionsService{*(lar::providerFrom<icarusDB::IPMTTimingCorrectionService const>())},
+      fPhotonCalibratorService{*(lar::providerFrom<icarusDB::ICARUSPhotonCalibratorServiceFromDB const>())},
       fOldTimingProvider{std::make_unique<icarusDB::PMTTimingCorrectionsProvider>(config.get<fhicl::ParameterSet>("OldTimingDBTags"))}
 {
     async<art::InEvent>();
@@ -141,7 +144,7 @@ icarus::OpHitRecalibrator::OpHitRecalibrator(fhicl::ParameterSet const &config,
     if (!fRecalibratePE && !fRecalibrateTime)
     {
         throw art::Exception{art::errors::Configuration}
-            << "No re-calibration selected. Why are you running meeee!?!?! :/\n";
+            << "No re-calibration selected. Why are you even running meeee,!?!?! :/\n";
     }
 
     if (fRecalibratePE && !fUseGainDatabase && (fSPEArea < 0))
@@ -161,11 +164,10 @@ icarus::OpHitRecalibrator::OpHitRecalibrator(fhicl::ParameterSet const &config,
                                          << " -> new " << fPMTTimingCorrectionsService.getCosmicsDatabaseTag();
     }
 
-    // FIXME: temporary since no gain db exists yet...
-    if (fUseGainDatabase)
+    if (fRecalibratePE && fUseGainDatabase)
     {
-        throw art::Exception{art::errors::Configuration}
-            << "Gain database interface doesn't exist yet. Try again later.\n";
+        mf::LogInfo("OpHitRecalibrator") << "Re-calibration of PE (gain) enabled:\n"
+                                         << "AreaTag: " << fPhotonCalibratorService.getAreaDatabaseTag();
     }
 
     // Consumes
@@ -218,9 +220,16 @@ void icarus::OpHitRecalibrator::produce(art::Event &event, art::ProcessingFrame
 
             if (fUseGainDatabase)
             {
-                // soon...
-                // newSPEArea = get_from_db(opHit.OpChannel())
+                // service directly returns PE from area and channel
+                // compute SPE area back for logging purposes
+                hitPE = fPhotonCalibratorService.PE(opHit.Area(), opHit.OpChannel());
+                newSPEArea = opHit.Area() / hitPE;
             }
+            else
+            {
+                // simple re-computation
+                hitPE = opHit.Area() / newSPEArea;
+            }   
 
             if (log)
             {
@@ -230,9 +239,7 @@ void icarus::OpHitRecalibrator::produce(art::Event &event, art::ProcessingFrame
                      << " (old SPEArea: " << oldSPEArea
                      << ") --> new PE " << opHit.Area() / newSPEArea
                      << " (new SPEArea: " << newSPEArea << ")\n";
-            }
-
-            hitPE = opHit.Area() / newSPEArea;
+            }            
         }
 
         // Second, recalibrate PMT times (if enabled)

icaruscode/PMT/Calibration/OpHitRecalibrator_module.cc

@@ -37,6 +37,7 @@ icarusDB::PhotonCalibratorFromDB::PhotonCalibratorFromDB(const Config& config)
   : fCalibDefaults( config.Defaults() )
   , fVerbose      ( config.Verbose() )
   , fLogCategory  ( config.LogCategory() )
+  , fAreaTag      ( config.AreaTag() )
   , fDB           ( config.DBname(), "", "", config.AreaTag(), true, false)
 {
   mf::LogInfo(fLogCategory)

icaruscode/PMT/Calibration/PhotonCalibratorFromDB.cxx

@@ -30,7 +30,6 @@ namespace icarusDB::details {
 
     /// Area [positive, ADC count sum] of response to single photoelectron.
     double speArea = -1.0;
-    
     double speAreaErr = -1.0;  /// Uncertainty on `speArea` [ADC count sum]
     double speFitWidth = -1.0;
     double speFitWidthErr = -1.0;
@@ -149,13 +148,17 @@ class icarusDB::PhotonCalibratorFromDB: public calib::IPhotonCalibrator {
      */
     std::uint64_t RunToDatabaseTimestamp( unsigned int run ) const;
 
+    /// Get current area database tag
+    std::string getAreaDatabaseTag() const override { return fAreaTag; }
+
   private:
 
     using PhotonCalibratorInfo = details::PhotonCalibratorInfo;
 
     PhotonCalibratorInfo const fCalibDefaults; ///< Default calibration values.
     bool const fVerbose;
     std::string const fLogCategory;
+    std::string const fAreaTag;
 
     lariov::DBFolder fDB; ///< Cached database interface.
 
@@ -168,7 +171,6 @@ class icarusDB::PhotonCalibratorFromDB: public calib::IPhotonCalibrator {
       return (it == fDatabaseSPECalibrations.end())? fCalibDefaults: it->second;
     }
 
-
 }; // class icarusDB::PhotonCalibratorFromDB