Add "inverse of nominal value" in GeV to MagneticField, and calculate nominal values in the constructor.

makortel · makortel · commit 5986927bf33f · 2021-08-31T03:10:02.000+02:00
This is a preparatory step to migrate PixelRecoUtilities to esConsumes
diff --git a/FastSimulation/TrajectoryManager/interface/LocalMagneticField.h b/FastSimulation/TrajectoryManager/interface/LocalMagneticField.h
@@ -12,7 +12,7 @@
 
 #include "MagneticField/Engine/interface/MagneticField.h"
 
-class LocalMagneticField : public MagneticField {
+class LocalMagneticField final : public MagneticField {
 public:
   ///Construct passing the Z field component in Tesla
   LocalMagneticField(double value);
diff --git a/FastSimulation/TrajectoryManager/src/LocalMagneticField.cc b/FastSimulation/TrajectoryManager/src/LocalMagneticField.cc
@@ -7,6 +7,6 @@
 #include "FastSimulation/TrajectoryManager/interface/LocalMagneticField.h"
 #include "DataFormats/GeometryVector/interface/GlobalVector.h"
 
-LocalMagneticField::LocalMagneticField(double value) : theField(0., 0., value) {}
+LocalMagneticField::LocalMagneticField(double value) : theField(0., 0., value) { setNominalValue(); }
 
 GlobalVector LocalMagneticField::inTesla(const GlobalPoint& gp) const { return theField; }
diff --git a/MagneticField/Engine/interface/MagneticField.h b/MagneticField/Engine/interface/MagneticField.h
@@ -46,20 +46,19 @@ class MagneticField {
   }
 
   /// The nominal field value for this map in kGauss
-  int nominalValue() const {
-    if (kSet == nominalValueCompiuted.load())
-      return theNominalValue;
-    return computeNominalValue();
-  }
+  int nominalValue() const { return theNominalValue; }
+
+  /// The inverse of nominal field value for this map in GeV
+  float inverseNominalValueInGeV() const { return theInverseNominalValueInGeV; }
+
+protected:
+  // need to be called from the constructor of the deriving classes
+  void setNominalValue();
 
 private:
-  //nominal field value
-  virtual int computeNominalValue() const;
-  mutable std::atomic<char> nominalValueCompiuted;
-  //  CMS_THREAD_GUARD(nominalValueCompiuted) mutable int theNominalValue;
-  //  PG temporary fix for clang 3.4 which is not parsing thread_guard correctly
-  CMS_THREAD_SAFE mutable int theNominalValue;
-  enum FooStates { kUnset, kSetting, kSet };
+  //nominal field values
+  int theNominalValue = 0;
+  float theInverseNominalValueInGeV = 0;
 };
 
 #endif
diff --git a/MagneticField/Engine/src/MagneticField.cc b/MagneticField/Engine/src/MagneticField.cc
@@ -5,32 +5,14 @@
 
 #include "MagneticField/Engine/interface/MagneticField.h"
 
-MagneticField::MagneticField() : nominalValueCompiuted(kUnset), theNominalValue(0) {}
+MagneticField::MagneticField() = default;
 
-MagneticField::MagneticField(const MagneticField& orig) : nominalValueCompiuted(kUnset), theNominalValue(0) {
-  if (orig.nominalValueCompiuted.load() == kSet) {
-    theNominalValue = orig.theNominalValue;
-    nominalValueCompiuted.store(kSet);
-  }
-}
-
-MagneticField::~MagneticField() {}
-
-int MagneticField::computeNominalValue() const {
-  int tmp = int((inTesla(GlobalPoint(0.f, 0.f, 0.f))).z() * 10.f + 0.5f);
+MagneticField::MagneticField(const MagneticField& orig) = default;
 
-  //Try to cache
-  char expected = kUnset;
-  if (nominalValueCompiuted.compare_exchange_strong(expected, kSetting)) {
-    //it is our job to set the value
-    std::swap(theNominalValue, tmp);
+MagneticField::~MagneticField() = default;
 
-    //this must be after the swap
-    nominalValueCompiuted.store(kSet);
-    return theNominalValue;
-  }
-  //another thread beat us to trying to set theNominalValue
-  // since we don't know when the other thread will finish
-  // we just return tmp
-  return tmp;
+void MagneticField::setNominalValue() {
+  auto const at0z = inTesla(GlobalPoint(0.f, 0.f, 0.f)).z();
+  theNominalValue = int(at0z * 10.f + 0.5f);
+  theInverseNominalValueInGeV = 1.f / (at0z * 2.99792458e-3f);
 }
diff --git a/MagneticField/ParametrizedEngine/src/OAEParametrizedMagneticField.cc b/MagneticField/ParametrizedEngine/src/OAEParametrizedMagneticField.cc
@@ -12,12 +12,14 @@
 using namespace std;
 using namespace magfieldparam;
 
-OAEParametrizedMagneticField::OAEParametrizedMagneticField(float B) : theParam(B) {}
+OAEParametrizedMagneticField::OAEParametrizedMagneticField(float B) : theParam(B) { setNominalValue(); }
 
-OAEParametrizedMagneticField::OAEParametrizedMagneticField(string T) : theParam(T) {}
+OAEParametrizedMagneticField::OAEParametrizedMagneticField(string T) : theParam(T) { setNominalValue(); }
 
 OAEParametrizedMagneticField::OAEParametrizedMagneticField(const edm::ParameterSet& parameters)
-    : theParam(parameters.getParameter<string>("BValue")) {}
+    : theParam(parameters.getParameter<string>("BValue")) {
+  setNominalValue();
+}
 
 OAEParametrizedMagneticField::~OAEParametrizedMagneticField() {}
 
diff --git a/MagneticField/ParametrizedEngine/src/OAEParametrizedMagneticField.h b/MagneticField/ParametrizedEngine/src/OAEParametrizedMagneticField.h
@@ -22,7 +22,7 @@ namespace magfieldparam {
   class TkBfield;
 }
 
-class OAEParametrizedMagneticField : public MagneticField {
+class OAEParametrizedMagneticField final : public MagneticField {
 public:
   /// Constructor, pass value for nominal field
   explicit OAEParametrizedMagneticField(float B);
diff --git a/MagneticField/ParametrizedEngine/src/ParabolicParametrizedMagneticField.cc b/MagneticField/ParametrizedEngine/src/ParabolicParametrizedMagneticField.cc
@@ -11,10 +11,14 @@ using namespace std;
 
 // Default parameters are the best fit of 3.8T to the OAEParametrizedMagneticField parametrization.
 ParabolicParametrizedMagneticField::ParabolicParametrizedMagneticField()
-    : c1(3.8114), b0(-3.94991e-06), b1(7.53701e-06), a(2.43878e-11) {}
+    : c1(3.8114), b0(-3.94991e-06), b1(7.53701e-06), a(2.43878e-11) {
+  setNominalValue();
+}
 
 ParabolicParametrizedMagneticField::ParabolicParametrizedMagneticField(const vector<double>& parameters)
-    : c1(parameters[0]), b0(parameters[1]), b1(parameters[2]), a(parameters[3]) {}
+    : c1(parameters[0]), b0(parameters[1]), b1(parameters[2]), a(parameters[3]) {
+  setNominalValue();
+}
 
 ParabolicParametrizedMagneticField::~ParabolicParametrizedMagneticField() {}
 
diff --git a/MagneticField/ParametrizedEngine/src/ParabolicParametrizedMagneticField.h b/MagneticField/ParametrizedEngine/src/ParabolicParametrizedMagneticField.h
@@ -16,7 +16,7 @@ namespace edm {
   class ParameterSet;
 }
 
-class ParabolicParametrizedMagneticField : public MagneticField {
+class ParabolicParametrizedMagneticField final : public MagneticField {
 public:
   /// Default constructor, use default values for 3.8T map
   explicit ParabolicParametrizedMagneticField();
diff --git a/MagneticField/ParametrizedEngine/src/PolyFit2DParametrizedMagneticField.cc b/MagneticField/ParametrizedEngine/src/PolyFit2DParametrizedMagneticField.cc
@@ -14,11 +14,13 @@ using namespace magfieldparam;
 
 PolyFit2DParametrizedMagneticField::PolyFit2DParametrizedMagneticField(double bVal) : theParam(new BFit()) {
   theParam->SetField(bVal);
+  setNominalValue();
 }
 
 PolyFit2DParametrizedMagneticField::PolyFit2DParametrizedMagneticField(const edm::ParameterSet& parameters)
     : theParam(new BFit()) {
   theParam->SetField(parameters.getParameter<double>("BValue"));
+  setNominalValue();
 }
 
 PolyFit2DParametrizedMagneticField::~PolyFit2DParametrizedMagneticField() { delete theParam; }
diff --git a/MagneticField/ParametrizedEngine/src/PolyFit2DParametrizedMagneticField.h b/MagneticField/ParametrizedEngine/src/PolyFit2DParametrizedMagneticField.h
@@ -18,7 +18,7 @@ namespace magfieldparam {
   class BFit;
 }
 
-class PolyFit2DParametrizedMagneticField : public MagneticField {
+class PolyFit2DParametrizedMagneticField final : public MagneticField {
 public:
   /// Constructor. Fitted bVal for the nominal currents are:
   /// 2.0216; 3.5162;  3.8114; 4.01242188708911
diff --git a/MagneticField/UniformEngine/interface/UniformMagneticField.h b/MagneticField/UniformEngine/interface/UniformMagneticField.h
@@ -13,9 +13,9 @@
 class UniformMagneticField final : public MagneticField {
 public:
   ///Construct passing the Z field component in Tesla
-  UniformMagneticField(float value) : theField(0.f, 0.f, value) {}
+  UniformMagneticField(float value) : theField(0.f, 0.f, value) { setNominalValue(); }
 
-  UniformMagneticField(GlobalVector value) : theField(value) {}
+  UniformMagneticField(GlobalVector value) : theField(value) { setNominalValue(); }
 
   void set(GlobalVector value) { theField = value; }
   void set(float value) { set(GlobalVector(0.f, 0.f, value)); }
diff --git a/MagneticField/VolumeBasedEngine/interface/VolumeBasedMagneticField.h b/MagneticField/VolumeBasedEngine/interface/VolumeBasedMagneticField.h
@@ -15,7 +15,7 @@
 class testMagneticField;
 class testMagGeometryAnalyzer;
 
-class VolumeBasedMagneticField : public MagneticField {
+class VolumeBasedMagneticField final : public MagneticField {
   // For tests
   friend class testMagneticField;
   friend class testMagGeometryAnalyzer;
diff --git a/MagneticField/VolumeBasedEngine/src/VolumeBasedMagneticField.cc b/MagneticField/VolumeBasedEngine/src/VolumeBasedMagneticField.cc
@@ -15,7 +15,9 @@ VolumeBasedMagneticField::VolumeBasedMagneticField(int geomVersion,
       maxZ(zMax),
       paramField(param),
       magGeomOwned(true),
-      paramFieldOwned(isParamFieldOwned) {}
+      paramFieldOwned(isParamFieldOwned) {
+  setNominalValue();
+}
 
 VolumeBasedMagneticField::VolumeBasedMagneticField(const VolumeBasedMagneticField& vbf)
     : MagneticField::MagneticField(vbf),
@@ -26,6 +28,7 @@ VolumeBasedMagneticField::VolumeBasedMagneticField(const VolumeBasedMagneticFiel
       magGeomOwned(false),
       paramFieldOwned(false) {
   // std::cout << "VolumeBasedMagneticField::clone() (shallow copy)" << std::endl;
+  setNominalValue();
 }
 
 MagneticField* VolumeBasedMagneticField::clone() const { return new VolumeBasedMagneticField(*this); }
diff --git a/MagneticField/VolumeGeometry/interface/MagCylinder.h b/MagneticField/VolumeGeometry/interface/MagCylinder.h
@@ -13,7 +13,7 @@
 template <class T>
 class MagneticFieldProvider;
 
-class MagCylinder : public MagVolume {
+class MagCylinder final : public MagVolume {
 public:
   MagCylinder(const PositionType& pos,
               const RotationType& rot,
diff --git a/MagneticField/VolumeGeometry/interface/MagVolume6Faces.h b/MagneticField/VolumeGeometry/interface/MagVolume6Faces.h
@@ -20,7 +20,7 @@
 template <class T>
 class MagneticFieldProvider;
 
-class MagVolume6Faces : public MagVolume {
+class MagVolume6Faces final : public MagVolume {
 public:
   MagVolume6Faces(const PositionType& pos,
                   const RotationType& rot,
diff --git a/MagneticField/VolumeGeometry/src/MagCylinder.cc b/MagneticField/VolumeGeometry/src/MagCylinder.cc
@@ -32,6 +32,7 @@ MagCylinder::MagCylinder(const PositionType& pos,
   if (def != faces.size()) {
     throw MagGeometryError("MagCylinder constructed with wrong number/type of faces");
   }
+  setNominalValue();
 }
 
 bool MagCylinder::inside(const GlobalPoint& gp, double tolerance) const { return inside(toLocal(gp), tolerance); }
diff --git a/MagneticField/VolumeGeometry/src/MagVolume6Faces.cc b/MagneticField/VolumeGeometry/src/MagVolume6Faces.cc
@@ -5,7 +5,9 @@ MagVolume6Faces::MagVolume6Faces(const PositionType& pos,
                                  const std::vector<VolumeSide>& faces,
                                  const MagneticFieldProvider<float>* mfp,
                                  double sf)
-    : MagVolume(pos, rot, mfp, sf), volumeNo(0), copyno(0), theFaces(faces) {}
+    : MagVolume(pos, rot, mfp, sf), volumeNo(0), copyno(0), theFaces(faces) {
+  setNominalValue();
+}
 
 bool MagVolume6Faces::inside(const GlobalPoint& gp, double tolerance) const {
   // check if the point is on the correct side of all delimiting surfaces
diff --git a/RecoVertex/KinematicFitPrimitives/test/KinematicState_t.cpp b/RecoVertex/KinematicFitPrimitives/test/KinematicState_t.cpp
@@ -16,9 +16,11 @@
 
 #include <iostream>
 
-class ConstMagneticField : public MagneticField {
+class ConstMagneticField final : public MagneticField {
 public:
-  virtual GlobalVector inTesla(const GlobalPoint&) const { return GlobalVector(0, 0, 4); }
+  ConstMagneticField() { setNominalValue(); }
+
+  GlobalVector inTesla(const GlobalPoint&) const override { return GlobalVector(0, 0, 4); }
 };
 
 int main() {
diff --git a/TrackPropagation/RungeKutta/interface/defaultRKPropagator.h b/TrackPropagation/RungeKutta/interface/defaultRKPropagator.h
@@ -27,7 +27,9 @@ namespace defaultRKPropagator {
   class RKMagVolume final : public MagVolume {
   public:
     RKMagVolume(const PositionType& pos, const RotationType& rot, const MagneticFieldProvider<float>* mfp)
-        : MagVolume(pos, rot, mfp) {}
+        : MagVolume(pos, rot, mfp) {
+      setNominalValue();
+    }
 
     bool inside(const GlobalPoint& gp, double tolerance = 0.) const override { return true; }
 
diff --git a/TrackPropagation/RungeKutta/test/RKTest.cc b/TrackPropagation/RungeKutta/test/RKTest.cc
@@ -33,7 +33,8 @@
 
 class RKTestField final : public MagneticField {
 public:
-  virtual GlobalVector inTesla(const GlobalPoint&) const { return GlobalVector(0, 0, 4); }
+  RKTestField() { setNominalValue(); }
+  GlobalVector inTesla(const GlobalPoint&) const override { return GlobalVector(0, 0, 4); }
 };
 
 using namespace std;
diff --git a/TrackingTools/KalmanUpdators/test/KFUpdator_t.cpp b/TrackingTools/KalmanUpdators/test/KFUpdator_t.cpp
@@ -15,9 +15,10 @@
 #include "DataFormats/TrackerRecHit2D/interface/ProjectedSiStripRecHit2D.h"
 #include <iostream>
 
-class ConstMagneticField : public MagneticField {
+class ConstMagneticField final : public MagneticField {
 public:
-  virtual GlobalVector inTesla(const GlobalPoint&) const { return GlobalVector(0, 0, 4); }
+  ConstMagneticField() { setNominalValue(); }
+  GlobalVector inTesla(const GlobalPoint&) const override { return GlobalVector(0, 0, 4); }
 };
 
 #include "TrackingTools/AnalyticalJacobians/interface/JacobianLocalToCartesian.h"
diff --git a/TrackingTools/PatternTools/test/ClosestApproachInRPhi_t.cpp b/TrackingTools/PatternTools/test/ClosestApproachInRPhi_t.cpp
@@ -11,9 +11,10 @@
 
 #include <iostream>
 
-class ConstMagneticField : public MagneticField {
+class ConstMagneticField final : public MagneticField {
 public:
-  virtual GlobalVector inTesla(const GlobalPoint&) const { return GlobalVector(0, 0, 4); }
+  ConstMagneticField() { setNominalValue(); }
+  GlobalVector inTesla(const GlobalPoint&) const override { return GlobalVector(0, 0, 4); }
 };
 
 namespace {
diff --git a/TrackingTools/TrajectoryState/test/testTSOS.cpp b/TrackingTools/TrajectoryState/test/testTSOS.cpp
@@ -12,9 +12,10 @@
 
 #include <iostream>
 
-class ConstMagneticField : public MagneticField {
+class ConstMagneticField final : public MagneticField {
 public:
-  virtual GlobalVector inTesla(const GlobalPoint&) const { return GlobalVector(0, 0, 4); }
+  ConstMagneticField() { setNominalValue(); }
+  GlobalVector inTesla(const GlobalPoint&) const override { return GlobalVector(0, 0, 4); }
 };
 
 int main() {

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ namespace magfieldparam {`
`22`	`22`	`class TkBfield;`
`23`	`23`	`}`
`24`	`24`
`25`		`-class OAEParametrizedMagneticField : public MagneticField {`
	`25`	`+class OAEParametrizedMagneticField final : public MagneticField {`
`26`	`26`	`public:`
`27`	`27`	`/// Constructor, pass value for nominal field`
`28`	`28`	`explicit OAEParametrizedMagneticField(float B);`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ namespace edm {`
`16`	`16`	`class ParameterSet;`
`17`	`17`	`}`
`18`	`18`
`19`		`-class ParabolicParametrizedMagneticField : public MagneticField {`
	`19`	`+class ParabolicParametrizedMagneticField final : public MagneticField {`
`20`	`20`	`public:`
`21`	`21`	`/// Default constructor, use default values for 3.8T map`
`22`	`22`	`explicit ParabolicParametrizedMagneticField();`
Original file line number	Diff line number	Diff line change
`@@ -14,11 +14,13 @@ using namespace magfieldparam;`
`14`	`14`
`15`	`15`	`PolyFit2DParametrizedMagneticField::PolyFit2DParametrizedMagneticField(double bVal) : theParam(new BFit()) {`
`16`	`16`	`theParam->SetField(bVal);`
	`17`	`+ setNominalValue();`
`17`	`18`	`}`
`18`	`19`
`19`	`20`	`PolyFit2DParametrizedMagneticField::PolyFit2DParametrizedMagneticField(const edm::ParameterSet& parameters)`
`20`	`21`	`: theParam(new BFit()) {`
`21`	`22`	`theParam->SetField(parameters.getParameter<double>("BValue"));`
	`23`	`+ setNominalValue();`
`22`	`24`	`}`
`23`	`25`
`24`	`26`	`PolyFit2DParametrizedMagneticField::~PolyFit2DParametrizedMagneticField() { delete theParam; }`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ namespace magfieldparam {`
`18`	`18`	`class BFit;`
`19`	`19`	`}`
`20`	`20`
`21`		`-class PolyFit2DParametrizedMagneticField : public MagneticField {`
	`21`	`+class PolyFit2DParametrizedMagneticField final : public MagneticField {`
`22`	`22`	`public:`
`23`	`23`	`/// Constructor. Fitted bVal for the nominal currents are:`
`24`	`24`	`/// 2.0216; 3.5162; 3.8114; 4.01242188708911`