PWGUD Table Producers modified to include the UPC Reco flag in collisions (AliceO2Group#7975)

* Add files via upload

* Add files via upload

* Add files via upload

* Add files via upload

* Please consider the following formatting changes

* Fix error in UPCCandProducer when building O2Physics

I assume the error is due to BCFlags table not to be joined with BC table

* Update UDCollisionsConverter.cxx

* Update DGBCCandProducer.cxx

* Update DGCandProducer.cxx

* Update SGCandProducer.cxx

* Update DGCandProducer.cxx

* Update UPCCandidateProducer.cxx

* Update DGBCCandProducer.cxx

* Update DGCandProducer.cxx

* Update SGCandProducer.cxx

* Please consider the following formatting changes

* Update UPCCandidateProducer.cxx

All BCs should have now have the same table definitions

* Update SGCandProducer.cxx

* Update DGCandProducer.cxx

* Update DGBCCandProducer.cxx

* Please consider the following formatting changes

* Update UPCCandidateProducer.cxx

* Please consider the following formatting changes

* Update UPCCandidateProducer.cxx

Fix typo probably introduced when global replace was done

* Update DGBCCandProducer.cxx

* Update DGCandProducer.cxx

* Update SGCandProducer.cxx

* Update DGBCCandProducer.cxx

fix of Vertex::UPCMode

* Update DGCandProducer.cxx

fix of Vertex::UPCMode

* Update SGCandProducer.cxx

fix of Vertex::UPCMode

* Update UPCCandidateProducer.cxx

TODO added to not forget the implementation of collision flag association via bc table is not fully correct.

bcs.iteratorAt(0) takes only first BC in a timeframe, and in an analysis task data should be processed TF-by-TF (if I'm not mistaken again), so it should be a corresponding BCId for each collision.
UPCCandidateProducer matches tracks by time (BC) independently of reconstructed vertices, so additional checks should be added at some point to determine settings for a given ITSROF based e.g. on track BCs.

* Update DGBCCandProducer.cxx

fix

* Update DGCandProducer.cxx

fix

* Update SGCandProducer.cxx

fix

* Update DGBCCandProducer.cxx

fix

* Update DGCandProducer.cxx

fix

* Update DGCandProducer.cxx

fix

* Update DGBCCandProducer.cxx

* Update DGBCCandProducer.cxx

* Update DGCandProducer.cxx

* Update SGCandProducer.cxx

---------

Co-authored-by: ALICE Action Bot <[email protected]>
Co-authored-by: rolavick <[email protected]>

Author: 3 people

PWGUD/DataModel/UDTables.h

@@ -151,7 +151,7 @@ DECLARE_SOA_INDEX_COLUMN(UDMcCollision, udMcCollision);
 
 } // namespace udcollision
 
-DECLARE_SOA_TABLE(UDCollisions, "AOD", "UDCOLLISION",
+DECLARE_SOA_TABLE(UDCollisions_000, "AOD", "UDCOLLISION",
                   o2::soa::Index<>,
                   udcollision::GlobalBC,
                   udcollision::RunNumber,
@@ -161,6 +161,18 @@ DECLARE_SOA_TABLE(UDCollisions, "AOD", "UDCOLLISION",
                   collision::NumContrib,
                   udcollision::NetCharge,
                   udcollision::RgtrwTOF);
+// Version with UPC Reco Flag
+DECLARE_SOA_TABLE_VERSIONED(UDCollisions_001, "AOD", "UDCOLLISION", 1,
+                            o2::soa::Index<>,
+                            udcollision::GlobalBC,
+                            udcollision::RunNumber,
+                            collision::PosX,
+                            collision::PosY,
+                            collision::PosZ,
+                            collision::Flags,
+                            collision::NumContrib,
+                            udcollision::NetCharge,
+                            udcollision::RgtrwTOF);
 
 DECLARE_SOA_TABLE(SGCollisions, "AOD", "SGCOLLISION",
                   udcollision::GapSide);
@@ -208,6 +220,8 @@ DECLARE_SOA_TABLE(UDCollsLabels, "AOD", "UDCOLLSLABEL",
 DECLARE_SOA_TABLE(UDMcCollsLabels, "AOD", "UDMCCOLLSLABEL",
                   udcollision::UDMcCollisionId);
 
+using UDCollisions = UDCollisions_001;
+
 using UDCollision = UDCollisions::iterator;
 using SGCollision = SGCollisions::iterator;
 using UDCollisionsSel = UDCollisionsSels::iterator;

PWGUD/TableProducer/Converters/CMakeLists.txt

@@ -14,3 +14,9 @@ o2physics_add_dpl_workflow(fwd-tracks-extra-converter
                            PUBLIC_LINK_LIBRARIES O2::Framework O2Physics::AnalysisCore
                            COMPONENT_NAME Analysis)
 
+
+o2physics_add_dpl_workflow(collisions-converter
+                           SOURCES UDCollisionsConverter.cxx
+                           PUBLIC_LINK_LIBRARIES O2::Framework O2Physics::AnalysisCore
+                           COMPONENT_NAME Analysis)
+

PWGUD/TableProducer/Converters/UDCollisionsConverter.cxx

@@ -0,0 +1,58 @@
+// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
+// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
+// All rights not expressly granted are reserved.
+//
+// This software is distributed under the terms of the GNU General Public
+// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
+//
+// In applying this license CERN does not waive the privileges and immunities
+// granted to it by virtue of its status as an Intergovernmental Organization
+// or submit itself to any jurisdiction.
+
+/// \file UDCollisionsConverter.cxx
+/// \brief Converts UDCollisions table from version 000 to 001
+
+/// This task allows for the conversion of the UDCollisions table from the version 000,
+/// that is before the introduction of Flags for UPC reconstruction
+/// to the version 001, that includes it
+
+/// executable name o2-analysis-ud-collisions-converter
+
+/// \author Sasha Bylinkin <[email protected]>
+
+#include "Framework/runDataProcessing.h"
+#include "Framework/AnalysisTask.h"
+#include "Framework/AnalysisDataModel.h"
+#include "PWGUD/DataModel/UDTables.h"
+
+using namespace o2;
+using namespace o2::framework;
+
+// Converts UDCollisions for version 000 to 001
+struct UDCollisionsConverter {
+  Produces<o2::aod::UDCollisions_001> udCollisions_001;
+
+  void process(o2::aod::UDCollisions_000 const& collisions)
+  {
+
+    for (const auto& collision : collisions) {
+
+      udCollisions_001(collision.globalBC(),
+                       collision.runNumber(),
+                       collision.posX(),
+                       collision.posY(),
+                       collision.posZ(),
+                       0.0f, // dummy UPC reco flag, not available in version 000
+                       collision.numContrib(),
+                       collision.netCharge(),
+                       collision.rgtrwTOF());
+    }
+  }
+};
+
+WorkflowSpec defineDataProcessing(ConfigContext const& cfgc)
+{
+  return WorkflowSpec{
+    adaptAnalysisTask<UDCollisionsConverter>(cfgc),
+  };
+}

PWGUD/TableProducer/DGBCCandProducer.cxx

@@ -17,6 +17,7 @@
 #include <algorithm>
 #include "Framework/runDataProcessing.h"
 #include "Framework/AnalysisTask.h"
+#include "ReconstructionDataFormats/Vertex.h"
 #include "PWGUD/DataModel/UDTables.h"
 #include "PWGUD/Core/UDHelpers.h"
 #include "PWGUD/Core/UPCHelpers.h"
@@ -279,11 +280,11 @@ struct DGBCCandProducer {
 
   // update UDTables
   template <typename TTracks>
-  void updateUDTables(bool onlyPV, int64_t colID, uint64_t bcnum, int rnum, float vx, float vy, float vz,
+  void updateUDTables(bool onlyPV, int64_t colID, uint64_t bcnum, int rnum, float vx, float vy, float vz, int flag,
                       uint16_t const& ntrks, int8_t const& ncharge, float const& rtrwTOF,
                       TTracks const& tracks, upchelpers::FITInfo const& fitInfo)
   {
-    outputCollisions(bcnum, rnum, vx, vy, vz, ntrks, ncharge, rtrwTOF);
+    outputCollisions(bcnum, rnum, vx, vy, vz, flag, ntrks, ncharge, rtrwTOF);
     outputCollisionsSels(fitInfo.ampFT0A, fitInfo.ampFT0C, fitInfo.timeFT0A, fitInfo.timeFT0C,
                          fitInfo.triggerMaskFT0,
                          fitInfo.ampFDDA, fitInfo.ampFDDC, fitInfo.timeFDDA, fitInfo.timeFDDC,
@@ -383,7 +384,7 @@ struct DGBCCandProducer {
 
     // check if DG event
     // distinguish between cases with and without associated BC
-    // 1. candidate has associated BC and associated collision    -> vertex position: col.[posX(), posY(), posZ()]
+    // 1. candidate has associated BC and associated collision    ->  position: col.[posX(), posY(), posZ()]
     // 2. candidate has associated BC but no associated collision ->                  [-2., 2., -2.]
     // 3. candidate has no associated BC                          ->                  [-3., 3., -3.]
     int isDG = -1;
@@ -415,8 +416,11 @@ struct DGBCCandProducer {
           registry.get<TH1>(HIST("table/candCase"))->Fill(1, 1.);
           rtrwTOF = udhelpers::rPVtrwTOF<true>(colTracks, col.numContrib());
           nCharge = udhelpers::netCharge<true>(colTracks);
-
-          updateUDTables(false, col.globalIndex(), bc.globalBC(), bc.runNumber(), col.posX(), col.posY(), col.posZ(),
+          int upc_flag = 0;
+          ushort flags = col.flags();
+          if (flags & dataformats::Vertex<o2::dataformats::TimeStamp<int>>::Flags::UPCMode)
+            upc_flag = 1;
+          updateUDTables(false, col.globalIndex(), bc.globalBC(), bc.runNumber(), col.posX(), col.posY(), col.posZ(), upc_flag,
                          col.numContrib(), nCharge, rtrwTOF, colTracks, fitInfo);
         }
       } else {
@@ -448,7 +452,7 @@ struct DGBCCandProducer {
           rtrwTOF = udhelpers::rPVtrwTOF<false>(tracksArray, tracksArray.size());
           nCharge = udhelpers::netCharge<false>(tracksArray);
 
-          updateUDTables(false, -1, bc.globalBC(), bc.runNumber(), -2., 2., -2,
+          updateUDTables(false, -1, bc.globalBC(), bc.runNumber(), -2., 2., -2, 0,
                          tracksArray.size(), nCharge, rtrwTOF, tracksArray, fitInfo);
         }
       }
@@ -494,7 +498,7 @@ struct DGBCCandProducer {
         rtrwTOF = udhelpers::rPVtrwTOF<false>(tracksArray, tracksArray.size());
         nCharge = udhelpers::netCharge<false>(tracksArray);
 
-        updateUDTables(false, -1, bcnum, tibc.runNumber(), -3., 3., -3,
+        updateUDTables(false, -1, bcnum, tibc.runNumber(), -3., 3., -3, 0,
                        tracksArray.size(), nCharge, rtrwTOF, tracksArray, fitInfo);
       }
     }
@@ -612,7 +616,11 @@ struct DGBCCandProducer {
             auto rtrwTOF = udhelpers::rPVtrwTOF<true>(colTracks, col.numContrib());
             auto nCharge = udhelpers::netCharge<true>(colTracks);
             udhelpers::getFITinfo(fitInfo, bc, bcs, ft0s, fv0as, fdds);
-            updateUDTables(false, col.globalIndex(), bcnum, bc.runNumber(), col.posX(), col.posY(), col.posZ(),
+            int upc_flag = 0;
+            ushort flags = col.flags();
+            if (flags & dataformats::Vertex<o2::dataformats::TimeStamp<int>>::Flags::UPCMode)
+              upc_flag = 1;
+            updateUDTables(false, col.globalIndex(), bcnum, bc.runNumber(), col.posX(), col.posY(), col.posZ(), upc_flag,
                            col.numContrib(), nCharge, rtrwTOF, colTracks, fitInfo);
             // fill UDZdcs
             if (bc.has_zdc()) {
@@ -681,7 +689,11 @@ struct DGBCCandProducer {
             }
 
             int64_t colID = withCollision ? col.globalIndex() : -1;
-            updateUDTables(false, colID, bcnum, tibc.runNumber(), vpos[0], vpos[1], vpos[2],
+            int upc_flag = 0;
+            ushort flags = col.flags();
+            if (flags & dataformats::Vertex<o2::dataformats::TimeStamp<int>>::Flags::UPCMode)
+              upc_flag = 1;
+            updateUDTables(false, colID, bcnum, tibc.runNumber(), vpos[0], vpos[1], vpos[2], upc_flag,
                            tracksArray.size(), nCharge, rtrwTOF, tracksArray, fitInfo);
             // fill UDZdcs
             if (bc.globalBC() == bcnum) {

PWGUD/TableProducer/DGCandProducer.cxx

@@ -14,6 +14,7 @@
 
 #include "Framework/runDataProcessing.h"
 #include "Framework/AnalysisTask.h"
+#include "ReconstructionDataFormats/Vertex.h"
 #include "PWGUD/DataModel/UDTables.h"
 #include "PWGUD/Core/UPCHelpers.h"
 #include "PWGUD/Core/DGSelector.h"
@@ -269,8 +270,12 @@ struct DGCandProducer {
 
       // update DG candidates tables
       auto rtrwTOF = udhelpers::rPVtrwTOF<true>(tracks, collision.numContrib());
+      int upc_flag = 0;
+      ushort flags = collision.flags();
+      if (flags & dataformats::Vertex<o2::dataformats::TimeStamp<int>>::Flags::UPCMode)
+        upc_flag = 1;
       outputCollisions(bc.globalBC(), bc.runNumber(),
-                       collision.posX(), collision.posY(), collision.posZ(),
+                       collision.posX(), collision.posY(), collision.posZ(), upc_flag,
                        collision.numContrib(), udhelpers::netCharge<true>(tracks),
                        rtrwTOF);
       outputCollisionsSels(fitInfo.ampFT0A, fitInfo.ampFT0C, fitInfo.timeFT0A, fitInfo.timeFT0C,

PWGUD/TableProducer/SGCandProducer.cxx

@@ -12,6 +12,7 @@
 #include <cmath>
 #include "Framework/ASoA.h"
 #include "Framework/AnalysisDataModel.h"
+#include "ReconstructionDataFormats/Vertex.h"
 #include "Common/CCDB/EventSelectionParams.h"
 #include "Common/DataModel/EventSelection.h"
 #include "CommonConstants/LHCConstants.h"
@@ -213,10 +214,15 @@ struct SGCandProducer {
       upchelpers::FITInfo fitInfo{};
       udhelpers::getFITinfo(fitInfo, newbc, bcs, ft0s, fv0as, fdds);
       // update SG candidates tables
+      int upc_flag = 0;
+      ushort flags = collision.flags();
+      if (flags & dataformats::Vertex<o2::dataformats::TimeStamp<int>>::Flags::UPCMode)
+        upc_flag = 1;
       outputCollisions(bc.globalBC(), bc.runNumber(),
-                       collision.posX(), collision.posY(), collision.posZ(),
+                       collision.posX(), collision.posY(), collision.posZ(), upc_flag,
                        collision.numContrib(), udhelpers::netCharge<true>(tracks),
                        1.); // rtrwTOF); //omit the calculation to speed up the things while skimming
+
       outputSGCollisions(issgevent);
       outputCollisionsSels(fitInfo.ampFT0A, fitInfo.ampFT0C, fitInfo.timeFT0A, fitInfo.timeFT0C,
                            fitInfo.triggerMaskFT0,