Utilities for MagField object regeneration

shahor02 · shahor02 · commit 82339d1d77bb · 2019-03-15T18:45:13.000+01:00
diff --git a/Common/Field/macro/README.md b/Common/Field/macro/README.md
@@ -0,0 +1,17 @@
+## Macros for magnetic field manipulations
+
+```o2::field::MagneticWrapperChebyshev``` class allows to dump the field data to text file and recreate it back as a ROOT object from this file. This is useful if one needs to change the name or the namespace of this class or persistent classes it usese internally (e.g. ``MathUtils/Chebyshev3D.h``, ``MathUtils/Chebyshev3DCalc.h``)
+
+* macro ``extractMapsAsText.C``
+
+Converts all magnetics field objects of MapClass in the inpFileName file to text files named as <prefix><map_name> in current directory, e.g.
+``root -b -q 'extractMapsAsText.C+("$O2_ROOT/share/Common/maps/mfchebKGI_sym.root")'``
+
+*  macro ``createMapsFromText.C``
+
+Converts all text files with name pattern ``<path>/<prefix>*`` to magnetic field object of MapClass and stores them in the outFileName root file, e.g.
+``root -b -q 'createMapsFromText.C+'``
+will create local ``mfchebKGI_sym.root``, which can substitute ``O2/Common/maps/mfchebKGI_sym.root`` file.
+
+Currently the MapClass is aliased to ``o2::field::MagneticWrapperChebyshev`` in both cases. If after ``extractMapsAsText.C`` macro the name of the underlying MapClass changes, this has to be reflected in the ``createMapsFromText.C``
+
diff --git a/Common/Field/macro/createMapsFromText.C b/Common/Field/macro/createMapsFromText.C
@@ -0,0 +1,48 @@
+#if !defined(__CLING__) || defined(__ROOTCLING__)
+#include "Field/MagneticWrapperChebyshev.h"
+#include <TSystem.h>
+#include <TFile.h>
+#include <TKey.h>
+#include <TList.h>
+#include <TIterator.h>
+#include <string>
+#include <iostream>
+#endif
+
+using MapClass = o2::field::MagneticWrapperChebyshev;
+
+// This macro converts all text files with name pattern <path>/<prefix>* to
+// mag.field object of MapClass and stores them in the outFileName root file
+
+int createMapsFromText(const std::string path = "./", // where to look for the text files
+                       const std::string outFileName = "mfchebKGI_sym.root",
+                       const std::string prefix = "_alice_mag_map_")
+{
+  int nMaps = 0;
+  TFile outFile(outFileName.c_str(), "recreate");
+  if (!outFile.IsOpen() || outFile.IsZombie()) {
+    std::cout << "Failed to open file " << outFileName << " to store the maps\n";
+    return nMaps;
+  }
+  auto dir = gSystem->OpenDirectory(path.c_str());
+  if (!dir) {
+    std::cout << "Failed to check the path " << path << "\n";
+  }
+  const char* np = nullptr;
+  while ((np = gSystem->GetDirEntry(dir))) {
+    std::string inpName = np;
+
+    if (inpName.rfind(prefix, 0) == 0) { // this is a mag. map text file
+      std::cout << "Creating map from " << inpName << "\n";
+      MapClass magmap;
+      magmap.loadData(inpName.c_str());
+      std::cout << "Saving new map " << magmap.GetName() << "\n";
+      magmap.Write();
+      nMaps++;
+    }
+  }
+  outFile.Close();
+  gSystem->FreeDirectory(dir);
+
+  return nMaps;
+}
diff --git a/Common/Field/macro/extractMapsAsText.C b/Common/Field/macro/extractMapsAsText.C
@@ -0,0 +1,43 @@
+#if !defined(__CLING__) || defined(__ROOTCLING__)
+#include "Field/MagneticWrapperChebyshev.h"
+#include <TSystem.h>
+#include <TFile.h>
+#include <TKey.h>
+#include <TList.h>
+#include <TIterator.h>
+#include <string>
+#include <iostream>
+#endif
+
+using MapClass = o2::field::MagneticWrapperChebyshev;
+
+// This macro converts all mag.field objects in the inpFileName file to text files named as <prefix><map_name>
+// in current directory
+
+int extractMapsAsText(const std::string inpFileName = "$O2_ROOT/share/Common/maps/mfchebKGI_sym.root",
+                      const std::string prefix = "_alice_mag_map_")
+{
+  int nMaps = 0;
+  TFile inpFile(inpFileName.c_str());
+  if (!inpFile.IsOpen() || inpFile.IsZombie()) {
+    std::cout << "Failed to open file " << inpFileName << " with maps\n";
+    return nMaps;
+  }
+
+  TIter nextKey(inpFile.GetListOfKeys());
+  TObject* obj = nullptr;
+  while ((obj = nextKey())) {
+    if (obj->IsA() == TKey::Class()) {
+      auto magmap = dynamic_cast<MapClass*>(inpFile.Get(obj->GetName()));
+      if (!magmap) {
+        std::cout << "Failed to load map " << obj->GetName();
+        return -nMaps;
+      }
+      std::string outName = prefix + obj->GetName() + ".txt";
+      std::cout << "Dumping map " << obj->GetName() << " as a text to " << outName << "\n";
+      magmap->saveData(outName.c_str());
+      nMaps++;
+    }
+  }
+  return nMaps;
+}
diff --git a/Common/Field/src/MagneticWrapperChebyshev.cxx b/Common/Field/src/MagneticWrapperChebyshev.cxx
@@ -1402,14 +1402,12 @@ void MagneticWrapperChebyshev::saveData(const char* outfile) const
   fprintf(stream, "#\nEND SOLENOID\n");
 
   // TPCIntegral part
-  fprintf(stream, "# Set of Chebyshev parameterizations for ALICE magnetic field\nSTART %s\n", GetName());
   fprintf(stream, "START TPCINT\n#Number of pieces\n%d\n", mNumberOfParameterizationTPC);
   for (int ip = 0; ip < mNumberOfParameterizationTPC; ip++)
     getParameterTPCIntegral(ip)->saveData(stream);
   fprintf(stream, "#\nEND TPCINT\n");
 
   // TPCRatIntegral part
-  fprintf(stream, "# Set of Chebyshev parameterizations for ALICE magnetic field\nSTART %s\n", GetName());
   fprintf(stream, "START TPCRatINT\n#Number of pieces\n%d\n", mNumberOfParameterizationTPCRat);
   for (int ip = 0; ip < mNumberOfParameterizationTPCRat; ip++) {
     getParameterTPCRatIntegral(ip)->saveData(stream);
