MagField object added

chiarazampolli · chiarazampolli · commit df8ed9b8117e · 2021-10-16T00:15:11.000+02:00
clang-format
diff --git a/DataFormats/Detectors/Common/include/DetectorsCommonDataFormats/NameConf.h b/DataFormats/Detectors/Common/include/DetectorsCommonDataFormats/NameConf.h
@@ -52,6 +52,9 @@ class NameConf : public o2::conf::ConfigurableParamHelper<NameConf>
   // Filename of general run parameters from ECS (GRPECS)
   static std::string getGRPECSFileName(const std::string_view prefix = STANDARDSIMPREFIX);
 
+  // Filename of general run parameters fof B field (GRPMagField)
+  static std::string getGRPMagFieldFileName(const std::string_view prefix = STANDARDSIMPREFIX);
+
   // Filename to store kinematics + TrackRefs
   static std::string getMCKinematicsFileName(const std::string_view prefix = STANDARDSIMPREFIX)
   {
@@ -123,6 +126,7 @@ class NameConf : public o2::conf::ConfigurableParamHelper<NameConf>
   static constexpr std::string_view DIGITS_STRING = "Digits"; // hardcoded
   static constexpr std::string_view GRP_STRING = "grp";       // hardcoded
   static constexpr std::string_view GRPECS_STRING = "grpecs"; // hardcoded
+  static constexpr std::string_view GRPMAGFIELD_STRING = "grpMagField"; // hardcoded
   static constexpr std::string_view KINE_STRING = "Kine";     // hardcoded
   static constexpr std::string_view MCHEADER_STRING = "MCHeader"; // hardcoded
   static constexpr std::string_view GEOM_FILE_STRING = "geometry";
@@ -139,6 +143,7 @@ class NameConf : public o2::conf::ConfigurableParamHelper<NameConf>
   // these are configurable paths for some commonly used files
   std::string mDirGRP = "none";    // directory for GRP file ("none" == "")
   std::string mDirGRPECS = "none"; // directory for GRPECS file ("none" == "")
+  std::string mDirGRPMagField = "none"; // directory for GRPMagField file ("none" == "")
   std::string mDirGeom = "none";   // directory for geometry file
   std::string mDirMatLUT = "none"; // directory for material LUT
   std::string mDirCollContext = "none"; // directory for collision context
diff --git a/DataFormats/Detectors/Common/src/NameConf.cxx b/DataFormats/Detectors/Common/src/NameConf.cxx
@@ -61,6 +61,12 @@ std::string NameConf::getGRPECSFileName(const std::string_view prefix)
   return buildFileName(prefix, "_", STANDARDSIMPREFIX, GRPECS_STRING, ROOT_EXT_STRING, Instance().mDirGRPECS);
 }
 
+// Filename to store general run parameters from ECS (GRPECS)
+std::string NameConf::getGRPMagFieldFileName(const std::string_view prefix)
+{
+  return buildFileName(prefix, "_", STANDARDSIMPREFIX, GRPMAGFIELD_STRING, ROOT_EXT_STRING, Instance().mDirGRPMagField);
+}
+
 // Filename to store simulation cuts/process summary
 std::string NameConf::getCutProcFileName(std::string_view prefix)
 {
diff --git a/DataFormats/Parameters/CMakeLists.txt b/DataFormats/Parameters/CMakeLists.txt
@@ -13,6 +13,7 @@ o2_add_library(DataFormatsParameters
                SOURCES src/GRPObject.cxx
                        src/LHCIFData.cxx
                        src/GRPECSObject.cxx
+                       src/GRPMagField.cxx
                PUBLIC_LINK_LIBRARIES FairRoot::Base O2::CommonConstants
                                      O2::CommonTypes
                                      O2::DetectorsCommonDataFormats)
@@ -21,6 +22,7 @@ o2_target_root_dictionary(DataFormatsParameters
                           HEADERS include/DataFormatsParameters/GRPObject.h
                                   include/DataFormatsParameters/LHCIFData.h
                                   include/DataFormatsParameters/GRPECSObject.h
+                                  include/DataFormatsParameters/GRPMagField.h
                           LINKDEF src/ParametersDataLinkDef.h)
 
 
diff --git a/DataFormats/Parameters/include/DataFormatsParameters/GRPMagField.h b/DataFormats/Parameters/include/DataFormatsParameters/GRPMagField.h
@@ -0,0 +1,61 @@
+// Copyright 2019-2020 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.
+
+/// \file GRPMagField.h
+/// \brief Header of the General Run Parameters object for B field values
+/// \author ruben.shahoyan@cern.ch
+
+#ifndef ALICEO2_DATA_GRPMAGFIELDOBJECT_H_
+#define ALICEO2_DATA_GRPMAGFIELDOBJECT_H_
+
+#include <Rtypes.h>
+#include <cstdint>
+#include "CommonTypes/Units.h"
+
+namespace o2
+{
+namespace parameters
+{
+/*
+ * Collects parameters describing the run that are related to the B field only.
+*/
+
+class GRPMagField
+{
+ public:
+  GRPMagField() = default;
+  ~GRPMagField() = default;
+
+  /// getters/setters for magnets currents
+  o2::units::Current_t getL3Current() const { return mL3Current; }
+  o2::units::Current_t getDipoleCurrent() const { return mDipoleCurrent; }
+  bool getFieldUniformity() const { return mUniformField; }
+  void setL3Current(o2::units::Current_t v) { mL3Current = v; }
+  void setDipoleCurrent(o2::units::Current_t v) { mDipoleCurrent = v; }
+  void setFieldUniformity(bool v) { mUniformField = v; }
+
+  /// print itself
+  void print() const { printf("magnet currents (A) L3 = %.3f, Dipole = %.f; uniformity = %s\n", getL3Current(), getDipoleCurrent(), mUniformField ? "true" : "false"); }
+
+  static GRPMagField* loadFrom(const std::string& grpMagFieldFileName = "", const std::string& grpMagFieldName = "GRPMAGFIELD");
+
+ private:
+  o2::units::Current_t mL3Current = 0.f;     ///< signed current in L3
+  o2::units::Current_t mDipoleCurrent = 0.f; ///< signed current in Dipole
+  bool mUniformField = false;                ///< uniformity of magnetic field
+
+  ClassDefNV(GRPMagField, 1);
+};
+
+} // namespace parameters
+} // namespace o2
+
+#endif
diff --git a/DataFormats/Parameters/src/GRPECSObject.cxx b/DataFormats/Parameters/src/GRPECSObject.cxx
@@ -10,7 +10,7 @@
 // or submit itself to any jurisdiction.
 
 /// \file GRPECSObject.cxx
-/// \brief Implementation of General Run Parameters object
+/// \brief Implementation of General Run Parameters object from ECS
 /// \author ruben.shahoyan@cern.ch
 
 #include <FairLogger.h>
diff --git a/DataFormats/Parameters/src/GRPMagField.cxx b/DataFormats/Parameters/src/GRPMagField.cxx
@@ -0,0 +1,39 @@
+// Copyright 2019-2020 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.
+
+/// \file GRPMagField.cxx
+/// \brief Implementation of General Run Parameters object for MagField
+/// \author ruben.shahoyan@cern.ch
+
+#include <FairLogger.h>
+#include "DataFormatsParameters/GRPMagField.h"
+#include "DetectorsCommonDataFormats/NameConf.h"
+
+using namespace o2::parameters;
+
+//_______________________________________________
+GRPMagField* GRPMagField::loadFrom(const std::string& grpMagFieldFileName, const std::string& grpMagFieldName)
+{
+  // load object from file
+  auto fname = o2::base::NameConf::getGRPMagFieldFileName(grpMagFieldFileName);
+  TFile flGRPMagField(fname.c_str());
+  if (flGRPMagField.IsZombie()) {
+    LOG(ERROR) << "Failed to open " << fname;
+    throw std::runtime_error("Failed to open GRP Mag Field file");
+  }
+  auto grpMagField = reinterpret_cast<o2::parameters::GRPMagField*>(
+    flGRPMagField.GetObjectChecked(grpMagFieldName.data(), o2::parameters::GRPMagField::Class()));
+  if (!grpMagField) {
+    LOG(ERROR) << "Did not find GRP Mag Field object named " << grpMagFieldName;
+    throw std::runtime_error("Failed to load GRP Mag Field object");
+  }
+  return grpMagField;
+}
diff --git a/DataFormats/Parameters/src/ParametersDataLinkDef.h b/DataFormats/Parameters/src/ParametersDataLinkDef.h
@@ -27,5 +27,6 @@
 #pragma link C++ class o2::parameters::LHCIFData + ;
 #pragma link C++ class std::pair < long, std::string> + ;
 #pragma link C++ class o2::parameters::GRPECSObject + ;
+#pragma link C++ class o2::parameters::GRPMagField + ;
 
 #endif
diff --git a/macro/CMakeLists.txt b/macro/CMakeLists.txt
@@ -55,6 +55,7 @@ install(FILES CheckDigits_mft.C
               UploadDummyAlignment.C
               CreateCTPOrbitResetObject.C
               CreateGRPECSObject.C
+              CreateGRPMagFieldObject.C
         DESTINATION share/macro/)
 
 # FIXME: a lot of macros that are here should really be elsewhere. Those which
@@ -351,6 +352,18 @@ o2_add_test_root_macro(CreateGRPECSObject.C
                                              O2::DetectorsCommonDataFormats
                                              O2::CCDB)
 
+o2_add_test_root_macro(CreateGRPMagFieldObject.C
+                       PUBLIC_LINK_LIBRARIES O2::DataFormatsParameters
+                                             O2::CommonTypes
+                                             O2::CCDB)
+
+o2_add_test_root_macro(UploadMatBudLUT.C
+                       PUBLIC_LINK_LIBRARIES O2::DetectorsCommonDataFormats
+                                             O2::CCDB
+                                             O2::DataFormatsParameters
+                                             O2::DetectorsBase
+          O2::CommonUtils)
+
 #
 # NOTE: commented out until unit testing reenabled FIXME : re-enable or delete ?
 #
diff --git a/macro/CreateGRPMagFieldObject.C b/macro/CreateGRPMagFieldObject.C
@@ -0,0 +1,59 @@
+// Copyright 2019-2020 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.
+
+#if !defined(__CLING__) || defined(__ROOTCLING__)
+
+#include <ctime>
+#include <chrono>
+#include "DataFormatsParameters/GRPMagField.h"
+#include "CCDB/CcdbApi.h"
+#include "CommonTypes/Units.h"
+
+#endif
+
+using timePoint = std::time_t;
+using CcdbApi = o2::ccdb::CcdbApi;
+using GRPMagField = o2::parameters::GRPMagField;
+using current = o2::units::Current_t;
+
+// Simple macro to exemplify how to fill a GRPMagField object (GRP object containing the information on the magnetic field)
+
+// e.g.
+/*
+ .L CreateGRPMagFieldObject.C+
+ float l3 = 30000 // Ampere
+ float dipole = 6000 // Ampere
+ std::time_t tStart = std::chrono::duration_cast<std::chrono::seconds>(std::chrono::system_clock::now().time_since_epoch()).count()
+ std::time_t tEnd = (tStart + 60 * 60 * 24 * 365) * 1000; // 1 year validity, just an example
+ bool isUniform = true
+ int runNb = 123456
+ CreateGRPMagFieldObject(l3, dipole, tStart, runNb, tEnd, isUniform)
+*/
+
+void CreateGRPMagFieldObject(current l3, current dipole, timePoint start, int run, timePoint end = -1, bool isUniform = true, std::string ccdbPath = "http://ccdb-test.cern.ch:8080")
+{
+
+  GRPMagField grp;
+  grp.setL3Current(l3);
+  grp.setDipoleCurrent(dipole);
+  grp.setFieldUniformity(isUniform);
+
+  CcdbApi api;
+  api.init(ccdbPath);
+  std::map<std::string, std::string> metadata;
+  metadata["responsible"] = "DCS";
+  metadata["run_number"] = std::to_string(run);
+  //long ts = std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::system_clock::now().time_since_epoch()).count();
+  if (end < 0) {
+    end = (start + 60 * 60 * 10) * 1000; // start + 10h, in ms
+  }
+  api.storeAsTFileAny(&grp, "GLO/Config/GRPMagField", metadata, start * 1000, end); // making it 1-year valid to be sure we have something
+}

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,12 @@ std::string NameConf::getGRPECSFileName(const std::string_view prefix)`
`61`	`61`	`return buildFileName(prefix, "_", STANDARDSIMPREFIX, GRPECS_STRING, ROOT_EXT_STRING, Instance().mDirGRPECS);`
`62`	`62`	`}`
`63`	`63`
	`64`	`+// Filename to store general run parameters from ECS (GRPECS)`
	`65`	`+std::string NameConf::getGRPMagFieldFileName(const std::string_view prefix)`
	`66`	`+{`
	`67`	`+ return buildFileName(prefix, "_", STANDARDSIMPREFIX, GRPMAGFIELD_STRING, ROOT_EXT_STRING, Instance().mDirGRPMagField);`
	`68`	`+}`
	`69`	`+`
`64`	`70`	`// Filename to store simulation cuts/process summary`
`65`	`71`	`std::string NameConf::getCutProcFileName(std::string_view prefix)`
`66`	`72`	`{`