Rename TPCCATracking to GPUCATracking (it is not only TPC in the end)

davidrohr · davidrohr · commit 692384ea87fe · 2019-06-04T16:47:59.000+02:00
diff --git a/Detectors/TPC/reconstruction/CMakeLists.txt b/Detectors/TPC/reconstruction/CMakeLists.txt
@@ -15,7 +15,7 @@ set(SRCS
    src/RawReaderCRU.cxx
    src/RawReaderEventSync.cxx
    src/SyncPatternMonitor.cxx
-   src/TPCCATracking.cxx
+   src/GPUCATracking.cxx
    src/HardwareClusterDecoder.cxx
    src/DigitalCurrentClusterIntegrator.cxx
    src/TPCFastTransformHelperO2.cxx
@@ -33,7 +33,7 @@ set(HEADERS
    include/${MODULE_NAME}/RawReaderCRU.h
    include/${MODULE_NAME}/RawReaderEventSync.h
    include/${MODULE_NAME}/SyncPatternMonitor.h
-   include/${MODULE_NAME}/TPCCATracking.h
+   include/${MODULE_NAME}/GPUCATracking.h
    include/${MODULE_NAME}/HardwareClusterDecoder.h
    include/${MODULE_NAME}/DigitalCurrentClusterIntegrator.h
    include/${MODULE_NAME}/TPCFastTransformHelperO2.h
@@ -80,7 +80,7 @@ endforeach (_file RANGE 0 ${_length})
 set(TEST_SRCS
   test/testTPCSyncPatternMonitor.cxx
   test/testTPCAdcClockMonitor.cxx
-  test/testTPCCATracking.cxx
+  test/testGPUCATracking.cxx
   test/testTPCHwClusterer.cxx
   test/testTPCFastTransform.cxx
 )
diff --git a/Detectors/TPC/reconstruction/include/TPCReconstruction/DigitalCurrentClusterIntegrator.h b/Detectors/TPC/reconstruction/include/TPCReconstruction/DigitalCurrentClusterIntegrator.h
@@ -8,7 +8,7 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file TPCCATracking.h
+/// \file DigitalCurrentClusterIntegrator.h
 /// \brief Decoder to convert TPC ClusterHardware to ClusterNative
 /// \author David Rohr
 #ifndef ALICEO2_TPC_DIGITALCURRENTCLUSTERINTEGRATOR_H_
diff --git a/Detectors/TPC/reconstruction/include/TPCReconstruction/GPUCATracking.h b/Detectors/TPC/reconstruction/include/TPCReconstruction/GPUCATracking.h
@@ -8,7 +8,7 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file TPCCATracking.h
+/// \file GPUCATracking.h
 /// \brief Wrapper class for TPC CA Tracker algorithm
 /// \author David Rohr
 #ifndef ALICEO2_TPC_TPCCATRACKING_H_
@@ -27,20 +27,28 @@ class GPUTPCO2Interface;
 } // namespace gpu
 } // namespace o2
 
-namespace o2 { class MCCompLabel; namespace dataformats { template <class T> class MCTruthContainer; }}
+namespace o2
+{
+class MCCompLabel;
+namespace dataformats
+{
+template <class T>
+class MCTruthContainer;
+}
+} // namespace o2
 
 namespace o2
 {
 namespace tpc
 {
 
-class TPCCATracking
+class GPUCATracking
 {
-public:
-  TPCCATracking();
-  ~TPCCATracking();
-  TPCCATracking(const TPCCATracking&) = delete;            // Disable copy
-  TPCCATracking& operator=(const TPCCATracking&) = delete; // Disable assignment
+ public:
+  GPUCATracking();
+  ~GPUCATracking();
+  GPUCATracking(const GPUCATracking&) = delete;            // Disable copy
+  GPUCATracking& operator=(const GPUCATracking&) = delete; // Disable assignment
 
   int initialize(const o2::gpu::GPUO2InterfaceConfiguration& config);
   void deinitialize();
@@ -49,21 +57,21 @@ class TPCCATracking
   int runTracking(const o2::tpc::ClusterNativeAccessFullTPC& clusters, std::vector<TrackTPC>* outputTracks,
                   o2::dataformats::MCTruthContainer<o2::MCCompLabel>* outputTracksMCTruth = nullptr);
 
-  float getPseudoVDrift();                                            //Return artificial VDrift used to convert time to Z
-  float getTFReferenceLength() {return sContinuousTFReferenceLength;} //Return reference time frame length used to obtain Z from T in continuous data
-  int getNTracksASide() {return mNTracksASide;}
+  float getPseudoVDrift();                                              //Return artificial VDrift used to convert time to Z
+  float getTFReferenceLength() { return sContinuousTFReferenceLength; } //Return reference time frame length used to obtain Z from T in continuous data
+  int getNTracksASide() { return mNTracksASide; }
   void GetClusterErrors2(int row, float z, float sinPhi, float DzDs, float& ErrY2, float& ErrZ2) const;
 
  private:
   std::unique_ptr<o2::gpu::GPUTPCO2Interface> mTrackingCAO2Interface; //Pointer to Interface class in HLT O2 CA Tracking library.
                                                                       //The tracking code itself is not included in the O2 package, but contained in the CA library.
-                                                                      //The TPCCATracking class interfaces this library via this pointer to GPUTPCO2Interface class.
+                                                                      //The GPUCATracking class interfaces this library via this pointer to GPUTPCO2Interface class.
 
   static constexpr float sContinuousTFReferenceLength = 0.023 * 5e6;
   static constexpr float sTrackMCMaxFake = 0.1;
   int mNTracksASide = 0;
 };
 
-}
-}
+} // namespace tpc
+} // namespace o2
 #endif
diff --git a/Detectors/TPC/reconstruction/include/TPCReconstruction/HardwareClusterDecoder.h b/Detectors/TPC/reconstruction/include/TPCReconstruction/HardwareClusterDecoder.h
@@ -8,7 +8,7 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file TPCCATracking.h
+/// \file HardwareClusterDecoder.h
 /// \brief Decoder to convert TPC ClusterHardware to ClusterNative
 /// \author David Rohr
 #ifndef ALICEO2_TPC_HARDWARECLUSTERDECODER_H_
diff --git a/Detectors/TPC/reconstruction/src/GPUCATracking.cxx b/Detectors/TPC/reconstruction/src/GPUCATracking.cxx
@@ -8,10 +8,10 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file TPCCATracking.cxx
+/// \file GPUCATracking.cxx
 /// \author David Rohr
 
-#include "TPCReconstruction/TPCCATracking.h"
+#include "TPCReconstruction/GPUCATracking.h"
 
 #include "FairLogger.h"
 #include "ReconstructionDataFormats/Track.h"
@@ -38,10 +38,10 @@ using namespace o2::dataformats;
 
 using MCLabelContainer = MCTruthContainer<MCCompLabel>;
 
-TPCCATracking::TPCCATracking() : mTrackingCAO2Interface() {}
-TPCCATracking::~TPCCATracking() { deinitialize(); }
+GPUCATracking::GPUCATracking() : mTrackingCAO2Interface() {}
+GPUCATracking::~GPUCATracking() { deinitialize(); }
 
-int TPCCATracking::initialize(const GPUO2InterfaceConfiguration& config)
+int GPUCATracking::initialize(const GPUO2InterfaceConfiguration& config)
 {
   std::unique_ptr<TPCFastTransform> fastTransform(TPCFastTransformHelperO2::instance()->create(0));
   mTrackingCAO2Interface.reset(new GPUTPCO2Interface);
@@ -52,12 +52,12 @@ int TPCCATracking::initialize(const GPUO2InterfaceConfiguration& config)
   return (retVal);
 }
 
-void TPCCATracking::deinitialize()
+void GPUCATracking::deinitialize()
 {
   mTrackingCAO2Interface.reset();
 }
 
-int TPCCATracking::runTracking(const ClusterNativeAccessFullTPC& clusters, std::vector<TrackTPC>* outputTracks,
+int GPUCATracking::runTracking(const ClusterNativeAccessFullTPC& clusters, std::vector<TrackTPC>* outputTracks,
                                MCLabelContainer* outputTracksMCTruth)
 {
   auto& detParam = ParameterDetector::Instance();
@@ -221,14 +221,14 @@ int TPCCATracking::runTracking(const ClusterNativeAccessFullTPC& clusters, std::
   return (retVal);
 }
 
-float TPCCATracking::getPseudoVDrift()
+float GPUCATracking::getPseudoVDrift()
 {
   auto& gasParam = ParameterGas::Instance();
   auto& elParam = ParameterElectronics::Instance();
   return (elParam.ZbinWidth * gasParam.DriftV);
 }
 
-void TPCCATracking::GetClusterErrors2(int row, float z, float sinPhi, float DzDs, float& ErrY2, float& ErrZ2) const
+void GPUCATracking::GetClusterErrors2(int row, float z, float sinPhi, float DzDs, float& ErrY2, float& ErrZ2) const
 {
   if (mTrackingCAO2Interface == nullptr) {
     return;
diff --git a/Detectors/TPC/reconstruction/src/TPCReconstructionLinkDef.h b/Detectors/TPC/reconstruction/src/TPCReconstructionLinkDef.h
@@ -22,7 +22,7 @@
 #pragma link C++ class o2::tpc::RawReaderCRU;
 #pragma link C++ class o2::tpc::RawReaderEventSync;
 #pragma link C++ class o2::tpc::SyncPatternMonitor;
-#pragma link C++ class o2::tpc::TPCCATracking;
+#pragma link C++ class o2::tpc::GPUCATracking;
 #pragma link C++ class o2::tpc::HardwareClusterDecoder;
 
 #pragma link C++ class o2::tpc::Clusterer+;
diff --git a/Detectors/TPC/reconstruction/test/testGPUCATracking.cxx b/Detectors/TPC/reconstruction/test/testGPUCATracking.cxx
@@ -8,7 +8,7 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-/// \file testTPCCATracking.cxx
+/// \file testGPUCATracking.cxx
 /// \brief This task tests the TPC CA Tracking library
 /// \author David Rohr
 
@@ -21,7 +21,7 @@
 #include "DataFormatsTPC/TrackTPC.h"
 #include "DataFormatsTPC/ClusterNative.h"
 #include "DataFormatsTPC/ClusterNativeHelper.h"
-#include "TPCReconstruction/TPCCATracking.h"
+#include "TPCReconstruction/GPUCATracking.h"
 
 #include "GPUO2InterfaceConfiguration.h"
 #include "GPUReconstruction.h"
@@ -42,7 +42,7 @@ namespace tpc
 /// @brief Test 1 basic class IO tests
 BOOST_AUTO_TEST_CASE(CATracking_test1)
 {
-  TPCCATracking tracker;
+  GPUCATracking tracker;
 
   float solenoidBz = -5.00668; //B-field
   float refX = 1000.;          //transport tracks to this x after tracking, >500 for disabling
@@ -87,5 +87,5 @@ BOOST_AUTO_TEST_CASE(CATracking_test1)
   BOOST_CHECK_EQUAL(retVal, 0);
   BOOST_CHECK_EQUAL((int)tracks.size(), 1);
 }
-}
-}
+} // namespace tpc
+} // namespace o2
diff --git a/Detectors/TPC/workflow/README.md b/Detectors/TPC/workflow/README.md
@@ -16,7 +16,7 @@ The workflow consists of the following DPL processors:
 * `tpc-digit-reader` -> using tool [o2::framework::RootTreeReader](../../../Framework/Utils/include/Utils/RootTreeReader.h)
 * `tpc-clusterer` -> interfaces [o2::tpc::HwClusterer](../reconstruction/include/TPCReconstruction/HwClusterer.h)
 * `tpc-cluster-decoder` -> interfaces [o2::tpc::HardwareClusterDecoder](../reconstruction/include/TPCReconstruction/HardwareClusterDecoder.h)
-* `tpc-tracker`	-> interfaces [o2::tpc::TPCCATracking](../reconstruction/include/TPCReconstruction/TPCCATracking.h)
+* `tpc-tracker`	-> interfaces [o2::tpc::GPUCATracking](../reconstruction/include/TPCReconstruction/GPUCATracking.h)
 * `tpc-track-writer` -> implements simple writing to ROOT file
 
 Depending on the input and output types the default workflow is extended by the following readers and writers:
@@ -121,7 +121,7 @@ By default, all TPC sectors are processed by the workflow, option `--tpc-sectors
 ### Processor options
 
 #### TPC CA tracker
-The [tracker spec](src/CATrackerSpec.cxx) interfaces the [o2::tpc::TPCCATracking](../reconstruction/include/TPCReconstruction/TPCCATracking.h)
+The [tracker spec](src/CATrackerSpec.cxx) interfaces the [o2::tpc::GPUCATracking](../reconstruction/include/TPCReconstruction/GPUCATracking.h)
 worker class which can be initialized using an option string. The processor spec defines the option `--tracker-option`. Currently, the tracker
 should be run with options:
 ```
diff --git a/Detectors/TPC/workflow/src/CATrackerSpec.cxx b/Detectors/TPC/workflow/src/CATrackerSpec.cxx
@@ -24,7 +24,7 @@
 #include "DataFormatsTPC/ClusterNative.h"
 #include "DataFormatsTPC/ClusterNativeHelper.h"
 #include "DataFormatsTPC/Helpers.h"
-#include "TPCReconstruction/TPCCATracking.h"
+#include "TPCReconstruction/GPUCATracking.h"
 #include "GPUO2InterfaceConfiguration.h"
 #include "GPUDisplayBackend.h"
 #ifdef BUILD_EVENT_DISPLAY
@@ -65,7 +65,7 @@ DataProcessorSpec getCATrackerSpec(bool processMC, std::vector<int> const& input
     std::bitset<NSectors> validInputs = 0;
     std::bitset<NSectors> validMcInputs = 0;
     std::unique_ptr<ClusterGroupParser> parser;
-    std::unique_ptr<o2::tpc::TPCCATracking> tracker;
+    std::unique_ptr<o2::tpc::GPUCATracking> tracker;
     std::unique_ptr<o2::gpu::GPUDisplayBackend> displayBackend;
     int verbosity = 1;
     std::vector<int> inputIds;
@@ -81,7 +81,7 @@ DataProcessorSpec getCATrackerSpec(bool processMC, std::vector<int> const& input
       auto& parser = processAttributes->parser;
       auto& tracker = processAttributes->tracker;
       parser = std::make_unique<ClusterGroupParser>();
-      tracker = std::make_unique<o2::tpc::TPCCATracking>();
+      tracker = std::make_unique<o2::tpc::GPUCATracking>();
 
       // Prepare initialization of CATracker - we parse the deprecated option string here,
       // and create the proper configuration objects for compatibility.
@@ -180,7 +180,7 @@ DataProcessorSpec getCATrackerSpec(bool processMC, std::vector<int> const& input
 
       // Configuration is prepared, initialize the tracker.
       if (tracker->initialize(config) != 0) {
-        throw std::invalid_argument("TPCCATracking initialization failed");
+        throw std::invalid_argument("GPUCATracking initialization failed");
       }
       processAttributes->validInputs.reset();
       processAttributes->validMcInputs.reset();
diff --git a/macro/runCATrackingClusterNative.C b/macro/runCATrackingClusterNative.C
@@ -27,7 +27,7 @@
 #include "SimulationDataFormat/MCCompLabel.h"
 #include "SimulationDataFormat/MCTruthContainer.h"
 #include "DataFormatsTPC/Constants.h"
-#include "TPCReconstruction/TPCCATracking.h"
+#include "TPCReconstruction/GPUCATracking.h"
 #include "GPUO2InterfaceConfiguration.h"
 #include "DataFormatsTPC/TrackTPC.h"
 #else
@@ -46,14 +46,14 @@ using MCLabelContainer = MCTruthContainer<o2::MCCompLabel>;
 
 // This is a prototype of a macro to test running the HLT O2 CA Tracking library on a root input file containg
 // TClonesArray of clusters.
-// It wraps the TPCCATracking class
+// It wraps the GPUCATracking class
 int runCATrackingClusterNative(TString inputFile, TString outputFile)
 {
   if (inputFile.EqualTo("") || outputFile.EqualTo("")) {
     printf("Filename missing\n");
     return (1);
   }
-  TPCCATracking tracker;
+  GPUCATracking tracker;
 
   // Just some default options to keep the macro running for now
   // Should be deprecated anyway in favor of the TPC workflow

Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,10 @@`
`8`	`8`	`// granted to it by virtue of its status as an Intergovernmental Organization`
`9`	`9`	`// or submit itself to any jurisdiction.`
`10`	`10`
`11`		`-/// \file TPCCATracking.cxx`
	`11`	`+/// \file GPUCATracking.cxx`
`12`	`12`	`/// \author David Rohr`
`13`	`13`
`14`		`-#include "TPCReconstruction/TPCCATracking.h"`
	`14`	`+#include "TPCReconstruction/GPUCATracking.h"`
`15`	`15`
`16`	`16`	`#include "FairLogger.h"`
`17`	`17`	`#include "ReconstructionDataFormats/Track.h"`
`@@ -38,10 +38,10 @@ using namespace o2::dataformats;`
`38`	`38`
`39`	`39`	`using MCLabelContainer = MCTruthContainer<MCCompLabel>;`
`40`	`40`
`41`		`-TPCCATracking::TPCCATracking() : mTrackingCAO2Interface() {}`
`42`		`-TPCCATracking::~TPCCATracking() { deinitialize(); }`
	`41`	`+GPUCATracking::GPUCATracking() : mTrackingCAO2Interface() {}`
	`42`	`+GPUCATracking::~GPUCATracking() { deinitialize(); }`
`43`	`43`
`44`		`-int TPCCATracking::initialize(const GPUO2InterfaceConfiguration& config)`
	`44`	`+int GPUCATracking::initialize(const GPUO2InterfaceConfiguration& config)`
`45`	`45`	`{`
`46`	`46`	`std::unique_ptr<TPCFastTransform> fastTransform(TPCFastTransformHelperO2::instance()->create(0));`
`47`	`47`	`mTrackingCAO2Interface.reset(new GPUTPCO2Interface);`
`@@ -52,12 +52,12 @@ int TPCCATracking::initialize(const GPUO2InterfaceConfiguration& config)`
`52`	`52`	`return (retVal);`
`53`	`53`	`}`
`54`	`54`
`55`		`-void TPCCATracking::deinitialize()`
	`55`	`+void GPUCATracking::deinitialize()`
`56`	`56`	`{`
`57`	`57`	`mTrackingCAO2Interface.reset();`
`58`	`58`	`}`
`59`	`59`
`60`		`-int TPCCATracking::runTracking(const ClusterNativeAccessFullTPC& clusters, std::vector<TrackTPC>* outputTracks,`
	`60`	`+int GPUCATracking::runTracking(const ClusterNativeAccessFullTPC& clusters, std::vector<TrackTPC>* outputTracks,`
`61`	`61`	`MCLabelContainer* outputTracksMCTruth)`
`62`	`62`	`{`
`63`	`63`	`auto& detParam = ParameterDetector::Instance();`
`@@ -221,14 +221,14 @@ int TPCCATracking::runTracking(const ClusterNativeAccessFullTPC& clusters, std::`
`221`	`221`	`return (retVal);`
`222`	`222`	`}`
`223`	`223`
`224`		`-float TPCCATracking::getPseudoVDrift()`
	`224`	`+float GPUCATracking::getPseudoVDrift()`
`225`	`225`	`{`
`226`	`226`	`auto& gasParam = ParameterGas::Instance();`
`227`	`227`	`auto& elParam = ParameterElectronics::Instance();`
`228`	`228`	`return (elParam.ZbinWidth * gasParam.DriftV);`
`229`	`229`	`}`
`230`	`230`
`231`		`-void TPCCATracking::GetClusterErrors2(int row, float z, float sinPhi, float DzDs, float& ErrY2, float& ErrZ2) const`
	`231`	`+void GPUCATracking::GetClusterErrors2(int row, float z, float sinPhi, float DzDs, float& ErrY2, float& ErrZ2) const`
`232`	`232`	`{`
`233`	`233`	`if (mTrackingCAO2Interface == nullptr) {`
`234`	`234`	`return;`