Simplify hits: Cut inheritance from TObject/FairMultiLink_Interface

sawenzel · sawenzel · commit 610aaf2c276d · 2017-10-25T10:13:27.000+02:00
Major milestone in memory footprint reduction: Hits are now lean, non-virtual
data objects

* accompanying removal of FairLink references

* renaming o2::TPC::LinkableHitGroup -&gt; o2::TPC::HitGroup since
  the name "Linkable" referred to FairLinks

* adding missing header for FairRootManager which was
  implicitely available through removed FairMultiLink_Interface

* disabling one broken ROOT macro which needs major revision
  (is was broken before but the compilation complained now)
diff --git a/DataFormats/simulation/include/SimulationDataFormat/BaseHits.h b/DataFormats/simulation/include/SimulationDataFormat/BaseHits.h
@@ -10,7 +10,6 @@
 
 #ifndef ALICEO2_BASE_HIT_H
 #define ALICEO2_BASE_HIT_H
-#include "FairMultiLinkedData_Interface.h"
 #include "MathUtils/Cartesian3D.h"
 
 namespace o2
@@ -22,7 +21,7 @@ namespace o2
 // at the moment ony GetTrackID() used by Stack.h
 // eventually we could add some interfaces to retrieve
 // the coordinates as floats or something
-class BaseHit : public FairMultiLinkedData_Interface
+class BaseHit
 {
  public:
   BaseHit() = default;
@@ -32,7 +31,7 @@ class BaseHit : public FairMultiLinkedData_Interface
 
  private:
   int mTrackID = 0; // track_id
-  ClassDefOverride(BaseHit, 1);
+  ClassDefNV(BaseHit, 1);
 };
 
 // a set of configurable classes to define basic hit types
@@ -84,7 +83,7 @@ class BasicXYZEHit : public BaseHit
   }
   void SetPos(Point3D<T> const &p) { mPos = p; }
 
-  ClassDefOverride(BasicXYZEHit, 1);
+  ClassDefNV(BasicXYZEHit, 1);
 };
 
 } // end namespace AliceO2
diff --git a/DataFormats/simulation/src/Stack.cxx b/DataFormats/simulation/src/Stack.cxx
@@ -20,6 +20,7 @@
 #include "FairLogger.h"       // for MESSAGE_ORIGIN, FairLogger
 #include "SimulationDataFormat/BaseHits.h"
 #include "FairGenericRootManager.h"  // for FairGenericRootManager
+#include "FairRootManager.h"
 
 #include "TClonesArray.h"     // for TClonesArray
 #include "TIterator.h"        // for TIterator
@@ -333,7 +334,6 @@ void Stack::UpdateTrackIndex(TRefArray *detList)
           Fatal("Stack::UpdateTrackIndex", "Track index not found in map");
         }
         point->SetTrackID((*mIndexIterator).second);
-        point->SetLink(FairLink("MCTrack", (*mIndexIterator).second));
       }
 
     } // Collections of this detector
diff --git a/DataFormats/simulation/test/testBasicHits.cxx b/DataFormats/simulation/test/testBasicHits.cxx
@@ -51,13 +51,14 @@ BOOST_AUTO_TEST_CASE(BasicXYZHit_ROOTIO)
   // try writing hit to a TBuffer
   {
     TFile fout("HitsIO.root", "RECREATE");
-    fout.WriteTObject(&hit, "TestObject");
+    fout.WriteObject(&hit, "TestObject");
     fout.Close();
   }
 
   {
     TFile fin("HitsIO.root");
-    TObject* obj = (TObject*)fin.Get("TestObject");
+    HitType* obj = nullptr;
+    fin.GetObject("TestObject", obj);
 
     BOOST_CHECK(obj != nullptr);
     fin.Close();
@@ -70,13 +71,14 @@ BOOST_AUTO_TEST_CASE(BasicXYZHit_ROOTIO)
   // try writing hit to a TBuffer
   {
     TFile fout("HitsIO.root", "RECREATE");
-    fout.WriteTObject(&hitD, "TestObject");
+    fout.WriteObject(&hitD, "TestObject");
     fout.Close();
   }
 
   {
     TFile fin("HitsIO.root");
-    TObject* obj = (TObject*)fin.Get("TestObject");
+    HitTypeD* obj = nullptr;
+    fin.GetObject("TestObject", obj);
 
     BOOST_CHECK(obj != nullptr);
     fin.Close();
diff --git a/Detectors/Base/include/DetectorsBase/Detector.h b/Detectors/Base/include/DetectorsBase/Detector.h
@@ -19,6 +19,7 @@
 #include <memory>
 
 #include "FairDetector.h"  // for FairDetector
+#include "FairRootManager.h"
 #include "Rtypes.h"        // for Float_t, Int_t, Double_t, Detector::Class, etc
 #include <cxxabi.h>
 #include <typeinfo>
diff --git a/Detectors/EMCAL/base/include/EMCALBase/Hit.h b/Detectors/EMCAL/base/include/EMCALBase/Hit.h
@@ -68,7 +68,7 @@ class Hit : public o2::BasicXYZEHit<float>
   Hit operator+(const Hit& rhs) const;
 
   /// \brief Destructor
-  ~Hit() override = default;
+  ~Hit() = default;
 
   /// \brief Get the initial energy of the primary particle entering EMCAL
   /// \return Energy of the primary particle entering EMCAL
@@ -104,7 +104,7 @@ class Hit : public o2::BasicXYZEHit<float>
   Int_t mParent;             ///< Parent particle that entered the EMCAL
   Double32_t mInitialEnergy; ///< Energy of the parent particle that entered the EMCAL
 
-  ClassDefOverride(Hit, 1);
+  ClassDefNV(Hit, 1);
 };
 
 std::ostream& operator<<(std::ostream& stream, const Hit& point);
diff --git a/Detectors/EMCAL/testsimulation/run_sim_emcal.C b/Detectors/EMCAL/testsimulation/run_sim_emcal.C
@@ -58,8 +58,6 @@ void run_sim_emcal(Int_t nEvents = 10, TString mcEngine = "TGeant3")
 
   // Create simulation run
   FairRunSim* run = new FairRunSim();
-  // enable usage of the fair link mechanism
-  run->SetUseFairLinks(kTRUE);
 
   run->SetName(mcEngine);      // Transport engine
   run->SetOutputFile(outFile); // Output file
diff --git a/Detectors/ITSMFT/common/simulation/include/ITSMFTSimulation/Hit.h b/Detectors/ITSMFT/common/simulation/include/ITSMFTSimulation/Hit.h
@@ -94,7 +94,7 @@ class Hit : public o2::BasicXYZEHit<Float_t,Float_t>
     Bool_t IsAliveStart()    const  { return mTrackStatusStart & kTrackAlive; }
 
     /// Output to screen
-    void Print(const Option_t *opt) const override;
+    void Print(const Option_t *opt) const;
     friend std::ostream &operator<<(std::ostream &of, const Hit &point)
     {
       of << "-I- Hit: O2its point for track " << point.GetTrackID() << " in detector " << point.GetDetectorID() << std::endl;
@@ -131,7 +131,7 @@ class Hit : public o2::BasicXYZEHit<Float_t,Float_t>
     UChar_t mTrackStatusEnd;                  ///< MC status flag at exit
     UChar_t mTrackStatusStart;                ///< MC status at starting point
 
-  ClassDefOverride(Hit, 3)
+  ClassDefNV(Hit, 3)
 };
 
 Hit::Hit(int trackID, unsigned short detID, const TVector3& startPos, const TVector3& endPos, const TVector3& startMom,
diff --git a/Detectors/TPC/simulation/include/TPCSimulation/Detector.h b/Detectors/TPC/simulation/include/TPCSimulation/Detector.h
@@ -127,7 +127,7 @@ class Detector: public o2::Base::Detector {
     void DefineSensitiveVolumes();
 
     /** container for produced hits */
-    std::vector<LinkableHitGroup>*  mHitsPerSectorCollection[Sector::MAXSECTOR]; //! container that keeps track-grouped hits per sector
+    std::vector<HitGroup>*  mHitsPerSectorCollection[Sector::MAXSECTOR]; //! container that keeps track-grouped hits per sector
 
     TString mGeoFileName;                  ///< Name of the file containing the TPC geometry
     size_t mEventNr;                       //!< current event number
diff --git a/Detectors/TPC/simulation/include/TPCSimulation/Digitizer.h b/Detectors/TPC/simulation/include/TPCSimulation/Digitizer.h
@@ -71,7 +71,7 @@ class Digitizer {
     /// Steer conversion of points to digits
     /// \param points Container with TPC points
     /// \return digits container
-    DigitContainer* Process(const std::vector<o2::TPC::LinkableHitGroup>& hits);
+    DigitContainer* Process(const std::vector<o2::TPC::HitGroup>& hits);
 
     DigitContainer *getDigitContainer() const { return mDigitContainer; }
 
diff --git a/Detectors/TPC/simulation/include/TPCSimulation/DigitizerTask.h b/Detectors/TPC/simulation/include/TPCSimulation/DigitizerTask.h
@@ -79,7 +79,7 @@ class DigitizerTask : public FairTask{
     bool                mDigitDebugOutput;    ///< Switch for the debug output of the DigitMC
     int                 mHitSector=-1; ///< which sector to treat
 
-    const std::vector<o2::TPC::LinkableHitGroup> *mSectorHitsArray[Sector::MAXSECTOR];
+    const std::vector<o2::TPC::HitGroup> *mSectorHitsArray[Sector::MAXSECTOR];
 
     ClassDefOverride(DigitizerTask, 1);
 };
diff --git a/Detectors/TPC/simulation/include/TPCSimulation/Point.h b/Detectors/TPC/simulation/include/TPCSimulation/Point.h
@@ -48,11 +48,9 @@ class ElementalHit {
 // a higher order hit class encapsulating
 // a set of elemental hits belonging to the same trackid (and sector)
 // construct used to do less MC truth linking and to save memory
-// this hitcontainer is linkable with FairLinks,
-// and can be stored as element of a TClonesArray into a branch
-class LinkableHitGroup : public o2::BaseHit {
+class HitGroup : public o2::BaseHit {
 public:
-  LinkableHitGroup() :
+  HitGroup() :
   o2::BaseHit(),
 #ifdef HIT_AOS
   mHits()
@@ -66,7 +64,7 @@ class LinkableHitGroup : public o2::BaseHit {
     {
     }
 
-  LinkableHitGroup(int trackID) :
+  HitGroup(int trackID) :
   o2::BaseHit(trackID),
 #ifdef HIT_AOS
   mHits()
@@ -80,7 +78,7 @@ class LinkableHitGroup : public o2::BaseHit {
   {
   }
 
-  ~LinkableHitGroup() override = default;
+  ~HitGroup() = default;
   
   void addHit(float x, float y, float z, float time, short e) {
 #ifdef HIT_AOS
@@ -111,21 +109,6 @@ class LinkableHitGroup : public o2::BaseHit {
 #endif
   }
 
-  // the Clear method of TObject
-  // called for instance from TClonesArray->Clear("C")
-  void Clear(Option_t */*option*/) override {
-#ifdef HIT_AOS
-    mHits.clear();
-#else
-    mHitsXVctr.clear();
-    mHitsYVctr.clear();
-    mHitsZVctr.clear();
-    mHitsTVctr.clear();
-    mHitsEVctr.clear();
-#endif
-    shrinkToFit();
-  }
-
   void shrinkToFit() {
     // shrink all the containers to have exactly the required size
     // might improve overall memory consumption
@@ -155,7 +138,7 @@ class LinkableHitGroup : public o2::BaseHit {
   std::vector<float> mHitsTVctr; 
   std::vector<short> mHitsEVctr; 
 #endif
-  ClassDefOverride(LinkableHitGroup, 1);
+  ClassDefNV(HitGroup, 1);
 };
 
 class Point : public o2::BasicXYZEHit<float>
@@ -176,17 +159,17 @@ class Point : public o2::BasicXYZEHit<float>
     Point(float x, float y, float z, float time, float nElectrons, float trackID, float detID);
 
     /// Destructor
-    ~Point() override = default;
+    ~Point() = default;
 
     /// Output to screen
-    void Print(const Option_t* opt) const override;
+    void Print(const Option_t* opt) const;
 
   private:
     /// Copy constructor
     Point(const Point& point);
     Point operator=(const Point& point);
 
-  ClassDefOverride(o2::TPC::Point,1)
+  ClassDefNV(o2::TPC::Point,1)
 };
 
 inline
diff --git a/Detectors/TPC/simulation/macro/testHitsDigitsClusters.C_broken b/Detectors/TPC/simulation/macro/testHitsDigitsClusters.C_broken
diff --git a/Detectors/TPC/simulation/src/Detector.cxx b/Detectors/TPC/simulation/src/Detector.cxx
@@ -67,7 +67,7 @@ Detector::Detector(Bool_t active)
     mEventNr(0)
 {
   for(int i=0;i<Sector::MAXSECTOR;++i){
-    mHitsPerSectorCollection[i]=new std::vector<o2::TPC::LinkableHitGroup>;
+    mHitsPerSectorCollection[i]=new std::vector<o2::TPC::HitGroup>;
   }
 }
 
@@ -272,7 +272,7 @@ Bool_t  Detector::ProcessHits(FairVolume* vol)
   static int oldSectorId = sectorID;
 
   //  a new group is starting -> put it into the container
-  static LinkableHitGroup *currentgroup = nullptr;
+  static HitGroup *currentgroup = nullptr;
   if (groupCounter == 0) {
     mHitsPerSectorCollection[sectorID]->emplace_back(trackID);
     currentgroup = &(mHitsPerSectorCollection[sectorID]->back());
diff --git a/Detectors/TPC/simulation/src/Digitizer.cxx b/Detectors/TPC/simulation/src/Digitizer.cxx
@@ -51,7 +51,7 @@ void Digitizer::init()
 //  mDebugTreePRF->Branch("GEMresponse", &GEMresponse, "CRU:timeBin:row:pad:nElectrons");
 }
 
-DigitContainer* Digitizer::Process(const std::vector<o2::TPC::LinkableHitGroup>& hits)
+DigitContainer* Digitizer::Process(const std::vector<o2::TPC::HitGroup>& hits)
 {
 //  mDigitContainer->reset();
   const static Mapper& mapper = Mapper::instance();
@@ -72,7 +72,7 @@ DigitContainer* Digitizer::Process(const std::vector<o2::TPC::LinkableHitGroup>&
 
   static size_t hitCounter=0;
   for(auto& inputgroup : hits) {
-    //    auto *inputgroup = static_cast<LinkableHitGroup*>(pointObject);
+    //    auto *inputgroup = static_cast<HitGroup*>(pointObject);
     const int MCTrackID = inputgroup.GetTrackID();
     for(size_t hitindex = 0; hitindex < inputgroup.getSize(); ++hitindex){
       const auto& eh = inputgroup.getHit(hitindex);
diff --git a/Detectors/TPC/simulation/src/DigitizerTask.cxx b/Detectors/TPC/simulation/src/DigitizerTask.cxx
@@ -74,15 +74,15 @@ InitStatus DigitizerTask::Init()
     std::stringstream sectornamestr;
     sectornamestr << "TPCHitsSector" << mHitSector;
     LOG(INFO) << "FETCHING HITS FOR SECTOR " << mHitSector << "\n";
-    mSectorHitsArray[mHitSector] = mgr->InitObjectAs<const std::vector<LinkableHitGroup>*>(sectornamestr.str().c_str());
+    mSectorHitsArray[mHitSector] = mgr->InitObjectAs<const std::vector<HitGroup>*>(sectornamestr.str().c_str());
   }
   else {
     // in case we are treating all sectors
     for (int s=0;s<Sector::MAXSECTOR;++s){
       std::stringstream sectornamestr;
       sectornamestr << "TPCHitsSector" << s;
       LOG(INFO) << "FETCHING HITS FOR SECTOR " << s << "\n";
-      mSectorHitsArray[s] = mgr->InitObjectAs<const std::vector<LinkableHitGroup>*>(sectornamestr.str().c_str());
+      mSectorHitsArray[s] = mgr->InitObjectAs<const std::vector<HitGroup>*>(sectornamestr.str().c_str());
     }
   }
   
diff --git a/Detectors/TPC/simulation/src/Point.cxx b/Detectors/TPC/simulation/src/Point.cxx
@@ -27,5 +27,5 @@ void Point::Print(const Option_t* opt) const
 }
 
 ClassImp(Point)
-ClassImp(LinkableHitGroup)
+ClassImp(HitGroup)
 ClassImp(ElementalHit)
diff --git a/Detectors/TPC/simulation/src/TPCSimulationLinkDef.h b/Detectors/TPC/simulation/src/TPCSimulationLinkDef.h
@@ -41,10 +41,10 @@
 #pragma link C++ class o2::TPC::Point+;
 #pragma link C++ class o2::TPC::ElementalHit+;
 #pragma link C++ class std::vector<o2::TPC::ElementalHit>+;
-#pragma link C++ class o2::TPC::LinkableHitGroup+;
+#pragma link C++ class o2::TPC::HitGroup+;
 #pragma link C++ class o2::TPC::SAMPAProcessing+;
 
 #pragma link C++ class std::vector<o2::TPC::Cluster>+;
-#pragma link C++ class std::vector<o2::TPC::LinkableHitGroup>+;
+#pragma link C++ class std::vector<o2::TPC::HitGroup>+;
 
 #endif
diff --git a/Framework/TestWorkflows/src/o2_sim_tpc.cxx b/Framework/TestWorkflows/src/o2_sim_tpc.cxx
@@ -73,8 +73,6 @@ DataProcessorSpec sim_tpc() {
 
         // Create simulation run
         FairRunSim* run = new FairRunSim();
-        // enable usage of the fair link mechanism
-        run->SetUseFairLinks(kTRUE);
 
         run->SetName(mcEngine.c_str());
         run->SetOutputFile(outFile.c_str()); // Output file
diff --git a/macro/run_digi_tpc.C b/macro/run_digi_tpc.C
@@ -12,7 +12,6 @@
   #include "FairSystemInfo.h"
   #include "FairRuntimeDb.h"
   #include "FairParRootFileIo.h"
-  #include "FairLinkManager.h"
 
   #include "Field/MagneticField.h"
 
@@ -37,12 +36,6 @@ void run_digi_tpc(Int_t nEvents = 10, TString mcEngine = "TGeant3", Int_t isCont
         // Setup FairRoot analysis manager
         FairRunAna * run = new FairRunAna();
 
-        // ===| Activation of fair links for MC ID |============================
-        run->SetUseFairLinks(kTRUE);
-        // -- only store the link to the MC track
-        //    if commented, also the links to all previous steps will be stored
-        FairLinkManager::Instance()->AddIncludeType(0);
-
         FairFileSource *fFileSource = new FairFileSource(inputfile.str().c_str());
         run->SetSource(fFileSource);
         run->SetOutputFile(outputfile.str().c_str());
diff --git a/macro/run_sim_tpc.C b/macro/run_sim_tpc.C
@@ -56,8 +56,6 @@ void run_sim_tpc(Int_t nEvents = 10, TString mcEngine = "TGeant3")
 
   // Create simulation run
   FairRunSim* run = new FairRunSim();
-  // enable usage of the fair link mechanism
-  run->SetUseFairLinks(kTRUE);
 
   run->SetName(mcEngine);      // Transport engine
   run->SetOutputFile(outFile); // Output file

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`#include "FairLogger.h" // for MESSAGE_ORIGIN, FairLogger`
`21`	`21`	`#include "SimulationDataFormat/BaseHits.h"`
`22`	`22`	`#include "FairGenericRootManager.h" // for FairGenericRootManager`
	`23`	`+#include "FairRootManager.h"`
`23`	`24`
`24`	`25`	`#include "TClonesArray.h" // for TClonesArray`
`25`	`26`	`#include "TIterator.h" // for TIterator`
`@@ -333,7 +334,6 @@ void Stack::UpdateTrackIndex(TRefArray *detList)`
`333`	`334`	`Fatal("Stack::UpdateTrackIndex", "Track index not found in map");`
`334`	`335`	`}`
`335`	`336`	`point->SetTrackID((*mIndexIterator).second);`
`336`		`- point->SetLink(FairLink("MCTrack", (*mIndexIterator).second));`
`337`	`337`	`}`
`338`	`338`
`339`	`339`	`} // Collections of this detector`
Original file line number	Diff line number	Diff line change
`@@ -51,13 +51,14 @@ BOOST_AUTO_TEST_CASE(BasicXYZHit_ROOTIO)`
`51`	`51`	`// try writing hit to a TBuffer`
`52`	`52`	`{`
`53`	`53`	`TFile fout("HitsIO.root", "RECREATE");`
`54`		`- fout.WriteTObject(&hit, "TestObject");`
	`54`	`+ fout.WriteObject(&hit, "TestObject");`
`55`	`55`	`fout.Close();`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`{`
`59`	`59`	`TFile fin("HitsIO.root");`
`60`		`- TObject* obj = (TObject*)fin.Get("TestObject");`
	`60`	`+ HitType* obj = nullptr;`
	`61`	`+ fin.GetObject("TestObject", obj);`
`61`	`62`
`62`	`63`	`BOOST_CHECK(obj != nullptr);`
`63`	`64`	`fin.Close();`
`@@ -70,13 +71,14 @@ BOOST_AUTO_TEST_CASE(BasicXYZHit_ROOTIO)`
`70`	`71`	`// try writing hit to a TBuffer`
`71`	`72`	`{`
`72`	`73`	`TFile fout("HitsIO.root", "RECREATE");`
`73`		`- fout.WriteTObject(&hitD, "TestObject");`
	`74`	`+ fout.WriteObject(&hitD, "TestObject");`
`74`	`75`	`fout.Close();`
`75`	`76`	`}`
`76`	`77`
`77`	`78`	`{`
`78`	`79`	`TFile fin("HitsIO.root");`
`79`		`- TObject* obj = (TObject*)fin.Get("TestObject");`
	`80`	`+ HitTypeD* obj = nullptr;`
	`81`	`+ fin.GetObject("TestObject", obj);`
`80`	`82`
`81`	`83`	`BOOST_CHECK(obj != nullptr);`
`82`	`84`	`fin.Close();`