[Common] TPC interface: skipTPCOnly auto mode, fix Run 2 bug

Common/Tools/PID/pidTPCModule.h

@@ -33,6 +33,7 @@
 #include <Framework/AnalysisDataModel.h>
 #include <Framework/AnalysisHelpers.h>
 #include <Framework/Configurable.h>
+#include <Framework/RunningWorkflowInfo.h>
 #include <Framework/runDataProcessing.h>
 #include <ReconstructionDataFormats/PID.h>
 
@@ -84,14 +85,14 @@
 
 struct pidTPCConfigurables : o2::framework::ConfigurableGroup {
   std::string prefix = "pidTPC";
   o2::framework::Configurable<std::string> paramfile{"param-file", "", "Path to the parametrization object, if empty the parametrization is not taken from file"};
   o2::framework::Configurable<std::string> ccdbPath{"ccdbPath", "Analysis/PID/TPC/Response", "Path of the TPC parametrization on the CCDB"};
   o2::framework::Configurable<std::string> recoPass{"recoPass", "", "Reconstruction pass name for CCDB query (automatically takes latest object for timestamp if blank)"};
   o2::framework::Configurable<int64_t> ccdbTimestamp{"ccdb-timestamp", 0, "timestamp of the object used to query in CCDB the detector response. Exceptions: -1 gets the latest object, 0 gets the run dependent timestamp"};
   // Parameters for loading network from a file / downloading the file
   o2::framework::Configurable<bool> useNetworkCorrection{"useNetworkCorrection", 0, "(bool) Wether or not to use the network correction for the TPC dE/dx signal"};
   o2::framework::Configurable<bool> autofetchNetworks{"autofetchNetworks", 1, "(bool) Automatically fetches networks from CCDB for the correct run number"};
-  o2::framework::Configurable<bool> skipTPCOnly{"skipTPCOnly", false, "Flag to skip TPC only tracks (faster but affects the analyses that use TPC only tracks)"};
+  o2::framework::Configurable<int> skipTPCOnly{"skipTPCOnly", -1, "Flag to skip TPC only tracks (faster but affects the analyses that use TPC only tracks). 0: do not skip, 1: skip, -1: check if needed by specific tasks"};
   o2::framework::Configurable<std::string> networkPathLocally{"networkPathLocally", "network.onnx", "(std::string) Path to the local .onnx file. If autofetching is enabled, then this is where the files will be downloaded"};
   o2::framework::Configurable<std::string> networkPathCCDB{"networkPathCCDB", "Analysis/PID/TPC/ML", "Path on CCDB"};
   o2::framework::Configurable<bool> enableNetworkOptimizations{"enableNetworkOptimizations", 1, "(bool) If the neural network correction is used, this enables GraphOptimizationLevel::ORT_ENABLE_EXTENDED in the ONNX session"};
@@ -100,13 +101,13 @@
   o2::framework::Configurable<int> savedEdxsCorrected{"savedEdxsCorrected", -1, {"Save table with corrected dE/dx calculated on the spot. 0: off, 1: on, -1: auto"}};
   o2::framework::Configurable<bool> useCorrecteddEdx{"useCorrecteddEdx", false, "(bool) If true, use corrected dEdx value in Nsigma calculation instead of the one in the AO2D"};
 
   o2::framework::Configurable<int> pidFullEl{"pid-full-el", -1, {"Produce PID information for the Electron mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidFullMu{"pid-full-mu", -1, {"Produce PID information for the Muon mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidFullPi{"pid-full-pi", -1, {"Produce PID information for the Pion mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidFullKa{"pid-full-ka", -1, {"Produce PID information for the Kaon mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidFullPr{"pid-full-pr", -1, {"Produce PID information for the Proton mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidFullDe{"pid-full-de", -1, {"Produce PID information for the Deuterons mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidFullTr{"pid-full-tr", -1, {"Produce PID information for the Triton mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidFullHe{"pid-full-he", -1, {"Produce PID information for the Helium3 mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidFullAl{"pid-full-al", -1, {"Produce PID information for the Alpha mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
   o2::framework::Configurable<int> pidTinyEl{"pid-tiny-el", -1, {"Produce PID information for the Electron mass hypothesis, overrides the automatic setup: the corresponding table can be set off (0) or on (1)"}};
@@ -244,6 +245,62 @@
       LOGF(info, "***************************************************");
     }
 
+    if (pidTPCopts.skipTPCOnly.value == -1) {
+      LOGF(info, "***************************************************");
+      LOGF(info, " the skipTPConly flag has a value of -1! ");
+      LOGF(info, " ---> autodetecting TPC-only track necessity now ");
+      LOGF(info, "***************************************************");
+
+      // assume that TPC tracks are not needed, but check if tasks
+      // requiring them are present in the chain
+      pidTPCopts.skipTPCOnly.value = 1;
+
+      // loop over devices in this execution
+      auto& workflows = context.services().template get<o2::framework::RunningWorkflowInfo const>();
+      for (o2::framework::DeviceSpec const& device : workflows.devices) {
+        // Look for propagation service
+        if (device.name.compare("propagation-service") == 0) {
+          LOGF(info, " ---> propagation service detected, checking if photons enabled...");
+          for (auto const& option : device.options) {
+            // check for photon generation enabled or not
+            if (option.name.compare("v0BuilderOpts.generatePhotonCandidates") == 0) {
+              if (option.defaultValue.get<bool>()) {
+                LOGF(info, " ---> propagation service: photons enabled, will calculate TPC PID for TPC only tracks.");
+                pidTPCopts.skipTPCOnly.value = 0;
+              } else {
+                LOGF(info, " ---> propagation service: photons disabled, TPC PID not required for TPC-only tracks");
+              }
+            }
+          }
+        }
+
+        // if extra tasks require TPC PID for TPC-only tracks and enabling is to be automatic,
+        // this is the place where one should add the conditionals.
+        //
+        // note: this should be the device name (the name that gets printed in the
+        // logs when executing the task) and it is sufficient to just extend this array
+        // with the corresponding string.
+        std::vector<std::string> devicesRequiringTPCOnlyPID = {"photon-conversion-builder"};
+
+        // Check 2: specific tasks that require TPC PID
+        for (const std::string& requiringDevice : devicesRequiringTPCOnlyPID) {
+          if (device.name.compare(requiringDevice) == 0) {
+            LOGF(info, " ---> %s detected! ", requiringDevice);
+            LOGF(info, " ---> enabling TPC only track TPC PID calculations now.");
+            pidTPCopts.skipTPCOnly.value = 0;
+          }
+        }
+      }
+
+      if (pidTPCopts.skipTPCOnly.value == 1) {
+        LOGF(info, "***************************************************");
+        LOGF(info, "No need for TPC only information detected. Will not generate Nsigma for TPC only tracks");
+        LOGF(info, "If this is unexpected behaviour and a necessity was not identified, please add the");
+        LOGF(info, "corresponding task to the list 'devicesRequiringTPCOnlyPID' in pidTPCModule::Init()");
+      }
+      LOGF(info, "***************************************************");
+    }
+
     // initialize PID response
     response = new o2::pid::tpc::Response();