TPC: move PadFlags and related classes to TPCBaseRecSim

o2::tpc::PadFlags and in particular vectors of thereof are affected by an old ROOT
bug in serializing `std::vector<enum struct : short>`.

Because of this we have a custom streamer which needs to be initialised very early in order
to function correctly.

This is fine, however, due to the fact we invoke `TClass::GetClass()` too early, ROOT is
forced a bunch of extra stuff, unneededly, resulting in much increased memory footprint
in analysis, which happens to use DataFormatsTPC.

This makes sure the custom streamer is not initialised statically by DataFormatsTPC and
prevents ROOT from loading the kitchen sink when the TClass::GetClass is invoked too early.

Author: ktf

DataFormats/Detectors/TPC/include/DataFormatsTPC/Defs.h

@@ -97,23 +97,6 @@ enum class StatisticsType {
   MeanStdDev   ///< Use mean and standard deviation
 };
 
-enum class PadFlags : unsigned short {
-  flagGoodPad = 1 << 0,      ///< flag for a good pad binary 0001
-  flagDeadPad = 1 << 1,      ///< flag for a dead pad binary 0010
-  flagUnknownPad = 1 << 2,   ///< flag for unknown status binary 0100
-  flagSaturatedPad = 1 << 3, ///< flag for saturated status binary 0100
-  flagHighPad = 1 << 4,      ///< flag for pad with extremly high IDC value
-  flagLowPad = 1 << 5,       ///< flag for pad with extremly low IDC value
-  flagSkip = 1 << 6,         ///< flag for defining a pad which is just ignored during the calculation of I1 and IDCDelta
-  flagFEC = 1 << 7,          ///< flag for a whole masked FEC
-  flagNeighbour = 1 << 8,    ///< flag if n neighbouring pads are outlier
-  flagAllNoneGood = flagDeadPad | flagUnknownPad | flagSaturatedPad | flagHighPad | flagLowPad | flagSkip | flagFEC | flagNeighbour,
-};
-
-inline PadFlags operator&(PadFlags a, PadFlags b) { return static_cast<PadFlags>(static_cast<int>(a) & static_cast<int>(b)); }
-inline PadFlags operator~(PadFlags a) { return static_cast<PadFlags>(~static_cast<int>(a)); }
-inline PadFlags operator|(PadFlags a, PadFlags b) { return static_cast<PadFlags>(static_cast<int>(a) | static_cast<int>(b)); }
-
 // default point definitions for PointND, PointNDlocal, PointNDglobal are in
 // MathUtils/CartesianND.h
 

DataFormats/Detectors/TPC/src/DataFormatsTPCLinkDef.h

@@ -22,15 +22,13 @@
 #pragma link C++ class o2::tpc::ClusterHardwareContainerFixedSize < 8192> + ;
 #pragma link C++ class o2::tpc::ClusterNativeContainer + ;
 #pragma link C++ class o2::tpc::Digit + ;
-#pragma link C++ enum o2::tpc::PadFlags + ; // enum itself
 #pragma link C++ class o2::tpc::ZeroSuppressedContainer8kb + ;
 #pragma link C++ class std::vector < o2::tpc::ClusterNative> + ;
 #pragma link C++ class std::vector < o2::tpc::ClusterNativeContainer> + ;
 #pragma link C++ class std::vector < o2::tpc::ClusterHardware> + ;
 #pragma link C++ class std::vector < o2::tpc::ClusterHardwareContainerFixedSize < 8192>> + ;
 #pragma link C++ class std::vector < o2::tpc::ClusterHardwareContainer8kb> + ;
 #pragma link C++ class std::vector < o2::tpc::Digit> + ;
-#pragma link C++ class std::vector < o2::tpc::PadFlags> + ;
 #pragma link C++ class std::vector < o2::tpc::ZeroSuppressedContainer8kb> + ;
 #pragma link C++ class o2::tpc::TrackTPC + ;
 #pragma link C++ class o2::tpc::LaserTrack + ;

Detectors/TPC/CMakeLists.txt

@@ -10,6 +10,7 @@
 # or submit itself to any jurisdiction.
 
 add_subdirectory(base)
+add_subdirectory(baserecsim)
 add_subdirectory(reconstruction)
 add_subdirectory(calibration)
 add_subdirectory(simulation)

Detectors/TPC/base/CMakeLists.txt

@@ -12,7 +12,6 @@
 o2_add_library(TPCBase
                SOURCES src/CalArray.cxx
                        src/CalDet.cxx
-                       src/CDBInterface.cxx
                        src/ContainerFactory.cxx
                        src/CRU.cxx
                        src/DigitPos.cxx
@@ -24,7 +23,6 @@ o2_add_library(TPCBase
                        src/PadRegionInfo.cxx
                        src/PadROCPos.cxx
                        src/PadSecPos.cxx
-                       src/Painter.cxx
                        src/ParameterDetector.cxx
                        src/ParameterElectronics.cxx
                        src/ParameterGas.cxx
@@ -37,16 +35,13 @@ o2_add_library(TPCBase
                        src/CRUCalibHelpers.cxx
                        src/IonTailSettings.cxx
                        src/FEEConfig.cxx
-                       src/DeadChannelMapCreator.cxx
                        src/CommonModeCorrection.cxx
                PUBLIC_LINK_LIBRARIES Vc::Vc Boost::boost O2::DataFormatsTPC
                                      O2::DetectorsRaw O2::CCDB FairRoot::Base)
 
 o2_target_root_dictionary(TPCBase
-                          EXTRA_PATCH src/TPCFlagsMemberCustomStreamer.cxx
                           HEADERS include/TPCBase/CalArray.h
                                   include/TPCBase/CalDet.h
-                                  include/TPCBase/CDBInterface.h
                                   include/TPCBase/ContainerFactory.h
                                   include/TPCBase/CRU.h
                                   include/TPCBase/DigitPos.h
@@ -58,7 +53,6 @@ o2_target_root_dictionary(TPCBase
                                   include/TPCBase/PadRegionInfo.h
                                   include/TPCBase/PadROCPos.h
                                   include/TPCBase/PadSecPos.h
-                                  include/TPCBase/Painter.h
                                   include/TPCBase/ParameterDetector.h
                                   include/TPCBase/ParameterElectronics.h
                                   include/TPCBase/ParameterGas.h
@@ -71,26 +65,13 @@ o2_target_root_dictionary(TPCBase
                                   include/TPCBase/CRUCalibHelpers.h
                                   include/TPCBase/IonTailSettings.h
                                   include/TPCBase/FEEConfig.h
-                                  include/TPCBase/DeadChannelMapCreator.h
-                                  include/TPCBase/CommonModeCorrection.h
-                                  include/TPCBase/CDBTypes.h)
+                                  include/TPCBase/CommonModeCorrection.h)
 o2_add_test(Base
             COMPONENT_NAME tpc
             PUBLIC_LINK_LIBRARIES O2::TPCBase
             SOURCES test/testTPCBase.cxx
             LABELS tpc)
 
-if(BUILD_SIMULATION)
-  # this test needs CCDB/XROOTD which is for sure
-  # available in the default-o2 software stack
-  o2_add_test(CalDet
-            COMPONENT_NAME tpc
-            PUBLIC_LINK_LIBRARIES O2::TPCBase
-            SOURCES test/testTPCCalDet.cxx
-            ENVIRONMENT O2_ROOT=${CMAKE_BINARY_DIR}/stage
-            LABELS tpc)
-endif()
-
 o2_add_test(Mapper
             COMPONENT_NAME tpc
             PUBLIC_LINK_LIBRARIES O2::TPCBase

Detectors/TPC/base/src/TPCBaseLinkDef.h

@@ -21,20 +21,15 @@
 #pragma link C++ class o2::tpc::CalArray < unsigned> + ;
 #pragma link C++ class o2::tpc::CalArray < short> + ;
 #pragma link C++ class o2::tpc::CalArray < bool> + ;
-#pragma link C++ class o2::tpc::CalArray < o2::tpc::PadFlags> + ;
 #pragma link C++ class o2::tpc::CalDet < float> + ;
 #pragma link C++ class o2::tpc::CalDet < double> + ;
 #pragma link C++ class o2::tpc::CalDet < int> + ;
 #pragma link C++ class o2::tpc::CalDet < unsigned> + ;
 #pragma link C++ class o2::tpc::CalDet < short> + ;
 #pragma link C++ class o2::tpc::CalDet < bool> + ;
-#pragma link C++ class o2::tpc::CalDet < o2::tpc::PadFlags> + ;
 #pragma link C++ class std::vector < o2::tpc::CalDet < float>> + ;
 #pragma link C++ class std::vector < o2::tpc::CalDet < float>*> + ;
 #pragma link C++ class std::unordered_map < std::string, o2::tpc::CalDet < float>> + ;
-#pragma link C++ enum o2::tpc::CDBType;
-#pragma link C++ class o2::tpc::CDBInterface;
-#pragma link C++ class o2::tpc::CDBStorage;
 #pragma link C++ class o2::tpc::ContainerFactory;
 #pragma link C++ class o2::tpc::CRU;
 #pragma link C++ class o2::tpc::DigitPos;
@@ -50,8 +45,6 @@
 #pragma link C++ class o2::tpc::ROC;
 #pragma link C++ class o2::tpc::Sector;
 
-#pragma link C++ class o2::tpc::painter + ;
-
 // #pragma link C++ class std::vector <TCanvas*> + ;
 #pragma link C++ class o2::tpc::ParameterDetector;
 #pragma link C++ class o2::conf::ConfigurableParamHelper < o2::tpc::ParameterDetector> + ;
@@ -90,5 +83,4 @@
 #pragma link C++ function o2::tpc::cru_calib_helpers::getCalPad < 2>(const std::string_view, const std::string_view, std::string_view)
 #pragma link C++ function o2::tpc::cru_calib_helpers::getCalPad < 6>(const std::string_view, const std::string_view, std::string_view)
 
-#pragma link C++ class o2::tpc::DeadChannelMapCreator + ;
 #endif

Detectors/TPC/base/test/testTPCCDBInterface.cxx

@@ -21,7 +21,7 @@
 #include "TFile.h"
 
 // o2 includes
-#include "TPCBase/CDBInterface.h"
+#include "TPCBaseRecSim/CDBInterface.h"
 #include "TPCBase/CalArray.h"
 #include "TPCBase/CalDet.h"
 #include "TPCBase/Mapper.h"

Detectors/TPC/baserecsim/CMakeLists.txt

@@ -0,0 +1,35 @@
+# Copyright 2019-2025 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.
+
+o2_add_library(TPCBaseRecSim
+               SOURCES src/DeadChannelMapCreator.cxx
+                       src/Painter.cxx
+                       src/CDBInterface.cxx
+               PUBLIC_LINK_LIBRARIES O2::TPCBase)
+
+o2_target_root_dictionary(TPCBaseRecSim
+                          EXTRA_PATCH src/TPCFlagsMemberCustomStreamer.cxx
+                          HEADERS include/TPCBaseRecSim/Painter.h
+                                  include/TPCBaseRecSim/PadFlags.h
+                                  include/TPCBaseRecSim/DeadChannelMapCreator.h
+                                  include/TPCBaseRecSim/CDBTypes.h
+                                  include/TPCBaseRecSim/CDBInterface.h)
+
+if(BUILD_SIMULATION)
+  # this test needs CCDB/XROOTD which is for sure
+  # available in the default-o2 software stack
+  o2_add_test(CalDet
+            COMPONENT_NAME tpc
+            PUBLIC_LINK_LIBRARIES O2::TPCBaseRecSim
+            SOURCES test/testTPCCalDet.cxx
+            ENVIRONMENT O2_ROOT=${CMAKE_BINARY_DIR}/stage
+            LABELS tpc)
+endif()

…/TPC/base/include/TPCBase/CDBInterface.h …sim/include/TPCBaseRecSim/CDBInterface.hDetectors/TPC/base/include/TPCBase/CDBInterface.h renamed to Detectors/TPC/baserecsim/include/TPCBaseRecSim/CDBInterface.h Detectors/TPC/base/include/TPCBase/CDBInterface.h renamed to Detectors/TPC/baserecsim/include/TPCBaseRecSim/CDBInterface.h

@@ -25,8 +25,8 @@
 #include "CCDB/CcdbApi.h"
 #include "TPCBase/CalDet.h"
 #include "TPCBase/FEEConfig.h"
-#include "TPCBase/CDBTypes.h"
-#include "TPCBase/DeadChannelMapCreator.h"
+#include "TPCBaseRecSim/CDBTypes.h"
+#include "TPCBaseRecSim/DeadChannelMapCreator.h"
 #include "DataFormatsTPC/LtrCalibData.h"
 #include "DataFormatsTPC/Defs.h"
 #include "CommonUtils/NameConf.h"

…tors/TPC/base/include/TPCBase/CDBTypes.h …erecsim/include/TPCBaseRecSim/CDBTypes.hDetectors/TPC/base/include/TPCBase/CDBTypes.h renamed to Detectors/TPC/baserecsim/include/TPCBaseRecSim/CDBTypes.h Detectors/TPC/base/include/TPCBase/CDBTypes.h renamed to Detectors/TPC/baserecsim/include/TPCBaseRecSim/CDBTypes.h

@@ -21,8 +21,8 @@
 
 #include "CCDB/CcdbApi.h"
 
-#include "DataFormatsTPC/Defs.h"
-#include "TPCBase/CDBTypes.h"
+#include "TPCBaseRecSim/PadFlags.h"
+#include "TPCBaseRecSim/CDBTypes.h"
 #include "TPCBase/CalDet.h"
 #include "TPCBase/FEEConfig.h"