Add feminos-daq input run tree information to TRestRun (#155)

* Add input run tree info to TRestRun info

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add flag to use or not this feminos-daq run info

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Add brief documentation

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: AlvaroEzq

inc/TRestRawFeminosRootToSignalProcess.h

@@ -45,17 +45,29 @@ class TRestRawFeminosRootToSignalProcess : public TRestEventProcess {
     ULong64_t fInputEventTreeTimestamp = 0;                              //!
     std::vector<unsigned short>* fInputEventTreeSignalIds = nullptr;     //!
     std::vector<unsigned short>* fInputEventTreeSignalValues = nullptr;  //!
+    ULong64_t fStartTimestamp = -1;                                      //!
+    ULong64_t fEndTimestamp = 0;                                         //!
+    Bool_t fUseFeminosDaqRunInfo = true;                                 //<
 
    public:
     RESTValue GetInputEvent() const override { return RESTValue((TRestEvent*)nullptr); }
     RESTValue GetOutputEvent() const override { return fSignalEvent; }
 
     void InitProcess() override;
     void Initialize() override;
+    void EndProcess() override;
 
     TRestEvent* ProcessEvent(TRestEvent* inputEvent) override;
     const char* GetProcessName() const override { return "FeminosRootToSignal"; }
 
+    /// It prints out the process parameters stored in the metadata structure
+    inline void PrintMetadata() override {
+        BeginPrintProcess();
+        std::string useFemDaqRunInfoStr = fUseFeminosDaqRunInfo ? "true" : "false";
+        RESTMetadata << "Use feminos-daq run information: " << useFemDaqRunInfoStr << RESTendl;
+
+        EndPrintProcess();
+    }
     // Constructor
     TRestRawFeminosRootToSignalProcess();
     TRestRawFeminosRootToSignalProcess(const char* configFilename);
@@ -64,7 +76,7 @@ class TRestRawFeminosRootToSignalProcess : public TRestEventProcess {
     ~TRestRawFeminosRootToSignalProcess();
 
     ClassDefOverride(TRestRawFeminosRootToSignalProcess,
-                     1);  // Template for a REST "event process" class inherited from
+                     2);  // Template for a REST "event process" class inherited from
                           // TRestEventProcess
 };
 #endif

src/TRestRawFeminosRootToSignalProcess.cxx

@@ -21,9 +21,20 @@
  *************************************************************************/
 
 //////////////////////////////////////////////////////////////////////////
-/// The TRestRawFeminosRootToSignalProcess ...
+/// The TRestRawFeminosRootToSignalProcess converts the events acquired by
+/// the Feminos DAQ into TRestRawSignalEvent objects.
 ///
-/// DOCUMENTATION TO BE WRITTEN (main description, methods, data members)
+/// ### Parameters
+/// - **fUseFeminosDaqRunInfo**: Flag to determine if Feminos DAQ run info is transferred
+///  to the TRestRun object. If `true` (default), the run info such as start time,
+/// run number, tag, and description are set from the Feminos DAQ run info (stored
+/// in the run tree of the .root file). If `false`, this behavior is disabled and the
+/// start time is set from the first processed event timestamp. *Note: if you are using
+/// inputFormat in TRestRun to extract the run information (run number and tag usually),
+/// be aware that this happens before TRestRawFeminosRootToSignalProcess. The process,
+/// with fUseFeminosDaqRunInfo set to true, will overwrite the run info so the final
+/// values in the TRestRun will come from the .root file generated by feminos-daq,
+/// not the filename.*
 ///
 /// \warning This process might be obsolete today. It may need additional
 /// revision, validation, and documentation. Use it under your own risk. If you
@@ -56,6 +67,9 @@
 /// 2024-Aug: First implementation
 ///           Luis Obis
 ///
+/// 2025-May: Extract Feminos DAQ run info
+///           Álvaro Ezquerro
+///
 /// \class      TRestRawFeminosRootToSignalProcess
 /// \author     Luis Obis
 ///
@@ -109,7 +123,47 @@ void TRestRawFeminosRootToSignalProcess::InitProcess() {
         exit(1);
     }
 
-    fRunInfo->SetFeminosDaqTotalEvents(fInputEventTree->GetEntries());
+    if (fUseFeminosDaqRunInfo) {
+        ULong64_t startTimeStampMilliseconds = 0;
+        ULong64_t runNumber = 0;
+        std::string* runTag = new std::string();
+        std::string* runDescription = new std::string();
+        fInputRunTree->SetBranchAddress("timestamp", &startTimeStampMilliseconds);
+        fInputRunTree->SetBranchAddress("number", &runNumber);
+        fInputRunTree->SetBranchAddress("tag", &runTag);
+        fInputRunTree->SetBranchAddress("comments", &runDescription);
+
+        /* // Unused because they cannot be set in the run info
+        std::string* runComment = new std::string();
+        fInputRunTree->SetBranchAddress("comments", &runComment);
+        std::string* runDetector = new std::string();
+        fInputRunTree->SetBranchAddress("detector", &runDetector);
+        Float_t driftField = 0;
+        fInputRunTree->SetBranchAddress("drift_field_V_cm_bar", &driftField);
+        Float_t meshVoltage = 0;
+        fInputRunTree->SetBranchAddress("mesh_voltage_V", &meshVoltage);
+        Float_t detectorPressure = 0;
+        fInputRunTree->SetBranchAddress("detector_pressure_bar", &detectorPressure);
+        */
+
+        // retrieve row 0
+        fInputRunTree->GetEntry(0);
+
+        // set run info
+        Double_t startTimeStamp = startTimeStampMilliseconds / 1000.0;  // convert ms to seconds
+        fRunInfo->SetStartTimeStamp(startTimeStamp);
+        fRunInfo->SetRunNumber(runNumber);
+        // mclient sets the run tag and description to "\n" if they are empty
+        if (*runTag == "\n") {
+            runTag->clear();
+        }
+        if (*runDescription == "\n") {
+            runDescription->clear();
+        }
+        fRunInfo->SetRunTag(*runTag);
+        fRunInfo->SetRunDescription(*runDescription);
+        fRunInfo->SetFeminosDaqTotalEvents(fInputEventTree->GetEntries());
+    }
 
     fInputEventTree->SetBranchAddress("timestamp", &fInputEventTreeTimestamp);
     fInputEventTree->SetBranchAddress("signal_ids", &fInputEventTreeSignalIds);
@@ -126,6 +180,16 @@ TRestEvent* TRestRawFeminosRootToSignalProcess::ProcessEvent(TRestEvent* inputEv
     // fInputEventTreeTimestamp is in milliseconds and TRestEvent::SetTime(seconds, nanoseconds)
     fSignalEvent->SetTime(fInputEventTreeTimestamp / 1000, fInputEventTreeTimestamp % 1000 * 1000000);
 
+    // get the first event timestamp (if we are not using FeminosDaq run info where this is set from the run
+    // tree)
+    if (!fUseFeminosDaqRunInfo && fInputEventTreeTimestamp < fStartTimestamp) {
+        fStartTimestamp = fInputEventTreeTimestamp;
+    }
+    // get the last event timestamp
+    if (fInputEventTreeTimestamp > fEndTimestamp) {
+        fEndTimestamp = fInputEventTreeTimestamp;
+    }
+
     for (size_t i = 0; i < fInputEventTreeSignalIds->size(); i++) {
         auto signal = TRestRawSignal();
         signal.Initialize();
@@ -148,3 +212,12 @@ TRestEvent* TRestRawFeminosRootToSignalProcess::ProcessEvent(TRestEvent* inputEv
 
     return fSignalEvent;
 }
+
+void TRestRawFeminosRootToSignalProcess::EndProcess() {
+    // use first event timestamp as start of run if we are not using FeminosDaq run info
+    if (!fUseFeminosDaqRunInfo) {
+        fRunInfo->SetStartTimeStamp(fStartTimestamp / 1000.0);  // convert from ms to s
+    }
+    // use last event timestamp as end of run
+    fRunInfo->SetEndTimeStamp(fEndTimestamp / 1000.0);  // convert from ms to s
+}