Belle II Software  release-06-02-00
BFieldComponent3d.h
1 /**************************************************************************
2  * basf2 (Belle II Analysis Software Framework) *
3  * Author: The Belle II Collaboration *
4  * *
5  * See git log for contributors and copyright holders. *
6  * This file is licensed under LGPL-3.0, see LICENSE.md. *
7  **************************************************************************/
8 
9 #pragma once
10 
11 #include <geometry/bfieldmap/BFieldComponentAbs.h>
12 
13 #include <string>
14 
15 namespace Belle2 {
36 
37  public:
38 
40  BFieldComponent3d() = default;
41 
43  virtual ~BFieldComponent3d() = default;
44 
49  virtual void initialize() override;
50 
58  virtual B2Vector3D calculate(const B2Vector3D& point) const override;
59 
64  virtual void terminate() override;
65 
70  void setMapFilename(const std::string& filename) { m_mapFilename = filename; };
71 
78  void setMapSize(int sizeR, int sizePhi, int sizeZ) { m_mapSize[0] = sizeR; m_mapSize[1] = sizePhi; m_mapSize[2] = sizeZ; }
79 
86  void setMapRegionZ(double minZ, double maxZ, double offset) { m_mapRegionZ[0] = minZ; m_mapRegionZ[1] = maxZ; m_mapOffset = offset; }
87 
93  void setMapRegionR(double minR, double maxR) { m_mapRegionR[0] = minR; m_mapRegionR[1] = maxR; }
94 
101  void setGridPitch(double pitchR, double pitchPhi, double pitchZ) { m_gridPitch[0] = pitchR; m_gridPitch[1] = pitchPhi; m_gridPitch[2] = pitchZ; }
102 
108  void setExcludeRegionZ(double minZ, double maxZ) { m_exRegionZ[0] = minZ + m_mapOffset; m_exRegionZ[1] = maxZ + m_mapOffset; }
109 
115  void setExcludeRegionR(double minR, double maxR) { m_exRegionR[0] = minR; m_exRegionR[1] = maxR; }
116 
125  void setErrorRegionR(double minR = -1., double maxR = -1., double errBr = 0.0, double errBphi = 0.0, double errBz = 0.0)
126  { m_errRegionR[0] = minR; m_errRegionR[1] = maxR; m_errB[0] = errBr; m_errB[1] = errBphi; m_errB[2] = errBz; }
127 
131  void mirrorPhi(bool mirrorPhi = 0.) { m_mirrorPhi = mirrorPhi; }
132 
137 
142  void enableCoordinate(const std::string& mapEnable = "rphiz") { m_mapEnable = mapEnable; }
143  protected:
144 
145  private:
146 
150  B2Vector3D interpolate(unsigned int ir, unsigned int iphi, unsigned int iz, double wr, double wphi, double wz) const;
151 
153  std::string m_mapFilename{""};
155  std::vector<B2Vector3F> m_bmap;
157  std::string m_mapEnable{"rphiz"};
159  bool m_interpolate{true};
161  int m_mapSize[3];
163  double m_mapRegionZ[2] {0};
165  double m_mapOffset{0};
167  double m_mapRegionR[2] {0};
169  double m_gridPitch[3] {0};
171  double m_igridPitch[3] {0};
173  double m_exRegionZ[2] {0};
175  double m_exRegionR[2] {0};
177  bool m_exRegion{true};
179  bool m_mirrorPhi{true};
181  double m_errRegionR[2] {0};
183  double m_errB[3] {0};
184  };
185 
187 } //end of namespace Belle2
The BFieldComponent3d class.
B2Vector3D interpolate(unsigned int ir, unsigned int iphi, unsigned int iz, double wr, double wphi, double wz) const
Interpolate the value of B-field between (ir, iphi, iz) and (ir+1, iphi+1, iz+1) using weights (wr,...
double m_exRegionR[2]
The min and max boundaries of the excluded region in r.
void setExcludeRegionZ(double minZ, double maxZ)
Sets the size of the magnetic field map to exclude.
double m_errRegionR[2]
The min and max boundaries of the region in r to apply error.
virtual void initialize() override
Initializes the magnetic field component.
bool m_interpolate
Flag to switch on/off interpolation >
double m_gridPitch[3]
The grid pitch in r,phi,z.
void setErrorRegionR(double minR=-1., double maxR=-1., double errBr=0.0, double errBphi=0.0, double errBz=0.0)
Sets the size of the magnetic field map to apply error on B.
std::string m_mapFilename
The filename of the magnetic field map.
virtual void terminate() override
Terminates the magnetic field component.
double m_mapRegionZ[2]
The min and max boundaries of the map region in z.
double m_mapOffset
Offset required because the accelerator group defines the Belle center as zero.
int m_mapSize[3]
The size of the map in r, phi and z.
double m_igridPitch[3]
The inverted grid pitch in r,phi,z.
void setMapRegionR(double minR, double maxR)
Sets the size of the magnetic field map.
void setMapFilename(const std::string &filename)
Sets the filename of the magnetic field map.
bool m_exRegion
Flag to indicate whether there is a region to exclude.
void enableCoordinate(const std::string &mapEnable="rphiz")
Optino to reduce 3D to 2D map (in coordinates, NOT Br, Bphi, Bz components)
void setMapSize(int sizeR, int sizePhi, int sizeZ)
Sets the size of the magnetic field map.
double m_mapRegionR[2]
The min and max boundaries of the map region in r.
virtual B2Vector3D calculate(const B2Vector3D &point) const override
Calculates the magnetic field vector at the specified space point.
double m_exRegionZ[2]
The min and max boundaries of the excluded region in z.
void setExcludeRegionR(double minR, double maxR)
Sets the size of the magnetic field map to exclude.
void setGridPitch(double pitchR, double pitchPhi, double pitchZ)
Sets the grid pitch of the magnetic field map.
void setMapRegionZ(double minZ, double maxZ, double offset)
Sets the size of the magnetic field map.
double m_errB[3]
The error Br, Bphi, Bz as a scale factor (B_new = m_errB * B_old).
std::string m_mapEnable
Enable different dimension, "rphiz", "rphi", "phiz" or "rz" >
BFieldComponent3d()=default
The BFieldComponent3d constructor.
virtual ~BFieldComponent3d()=default
The BFieldComponent3d destructor.
bool m_mirrorPhi
Flag to indicate whether there is a region to exclude.
void doInterpolation(bool interpolate=true)
void mirrorPhi(bool mirrorPhi=0.)
std::vector< B2Vector3F > m_bmap
The memory buffer for the magnetic field map.
The BFieldComponentAbs class.
Abstract base class for different kinds of events.