Belle II Software  release-05-01-25
NeuroTrigger.h
1 #ifndef NEUROTRIGGER_H
2 #define NEUROTRIGGER_H
3 
4 #include <trg/cdc/dataobjects/CDCTriggerMLP.h>
5 #include <framework/datastore/StoreArray.h>
6 #include <framework/datastore/StoreObjPtr.h>
7 #include <framework/database/DBObjPtr.h>
8 #include <trg/cdc/dataobjects/CDCTriggerSegmentHit.h>
9 #include <trg/cdc/dbobjects/CDCTriggerNeuroConfig.h>
10 #include <framework/dataobjects/BinnedEventT0.h>
11 
12 namespace Belle2 {
18  class CDCTriggerTrack;
19 
31  class NeuroTrigger {
32  public:
37  struct Parameters {
43  unsigned nMLP = 1;
48  std::vector<std::vector<float>> nHidden = {{3.}};
50  bool targetZ = true;
52  bool targetTheta = false;
54  bool multiplyHidden = true;
56  std::vector<std::vector<float>> outputScale = {{ -1., 1.}};
58  std::vector<std::vector<float>> phiRange = {{0., 360.}};
60  std::vector<std::vector<float>> invptRange = {{ -5., 5.}};
62  std::vector<std::vector<float>> thetaRange = {{17., 150.}};
65  std::vector<std::vector<float>> phiRangeTrain = {{0., 360.}};
68  std::vector<std::vector<float>> invptRangeTrain = {{ -5., 5.}};
71  std::vector<std::vector<float>> thetaRangeTrain = {{17., 150.}};
73  std::vector<unsigned short> maxHitsPerSL = {1};
79  std::vector<unsigned long> SLpattern = {0};
86  std::vector<unsigned long> SLpatternMask = {0};
88  unsigned tMax = 256;
102  std::string et_option = "etf_or_fastestpriority";
104  bool T0fromHits = false;
105 
106  };
107 
110 
112  virtual ~NeuroTrigger() {}
113 
115  void initialize(const Parameters& p);
116 
118  std::vector<unsigned> getRangeIndices(const Parameters& p, unsigned isector);
119 
124  void save(const std::string& filename, const std::string& arrayname = "MLPs");
130  bool load(const std::string& filename, const std::string& arrayname = "MLPs");
131 
134  void setConstants();
135 
137  void setPrecision(std::vector<unsigned> precision) { m_precision = precision; }
138 
141  void initializeCollections(std::string hitCollectionName, std::string eventTimeName, std::string et_option);
142 
144  CDCTriggerMLP& operator[](unsigned index) { return m_MLPs[index]; }
146  const CDCTriggerMLP& operator[](unsigned index) const { return m_MLPs[index]; }
147 
149  unsigned nSectors() const { return m_MLPs.size(); }
150 
152  void addMLP(const CDCTriggerMLP& newMLP) { m_MLPs.push_back(newMLP); }
153 
161  std::vector<int> selectMLPs(float phi0, float invpt, float theta);
162 
168  int selectMLPbyPattern(std::vector<int>& MLPs, unsigned long pattern, const bool neurotrackinputmode);
169 
171  void updateTrack(const CDCTriggerTrack& track);
172 
174  void updateTrackFix(const CDCTriggerTrack& track);
175 
178  double getRelId(const CDCTriggerSegmentHit& hit);
194  void getEventTime(unsigned isector, const CDCTriggerTrack& track, std::string et_option, const bool);
195 
200  void getEventTime(unsigned isector, const CDCTriggerTrack& track);
201 
203  std::string get_et_option()
204  {
205  std::string eto = m_MLPs[0].get_et_option();
206  for (unsigned int i = 0; i < m_MLPs.size(); ++i) {
207  if (m_MLPs[i].get_et_option() != eto) {
208  B2ERROR("Timing options in the expert networks in the CDC Neurotrigger differ!");
209  }
210  }
211  return eto;
212 
213  }
214 
220  unsigned long getInputPattern(unsigned isector, const CDCTriggerTrack& track, const bool neurotrackinputmode);
221 
228  std::vector<unsigned> selectHitsHWSim(unsigned isector, const CDCTriggerTrack& track);
229 
236  std::vector<unsigned> selectHits(unsigned isector, const CDCTriggerTrack& track,
237  bool returnAllRelevant = false);
238 
244  std::vector<float> getInputVector(unsigned isector, const std::vector<unsigned>& hitIds);
245 
250  std::vector<float> runMLP(unsigned isector, std::vector<float> input);
251 
253  std::vector<float> runMLPFix(unsigned isector, std::vector<float> input);
254 
255  private:
257  std::vector<CDCTriggerMLP> m_MLPs = {};
259  double m_radius[9][2] = {};
261  unsigned m_TSoffset[10] = {};
263  double m_idRef[9][2] = {};
265  double m_alpha[9][2] = {};
267  int m_T0 = 0;
269  bool m_hasT0 = false;
277  std::vector<unsigned> m_precision;
278 
284  std::string m_hitCollectionName;
287 
288  };
290 }
291 #endif
Belle2::NeuroTrigger::updateTrack
void updateTrack(const CDCTriggerTrack &track)
Calculate 2D phi position and arclength for the given track and store them.
Definition: NeuroTrigger.cc:325
Belle2::NeuroTrigger::operator[]
CDCTriggerMLP & operator[](unsigned index)
return reference to a neural network
Definition: NeuroTrigger.h:144
Belle2::NeuroTrigger::m_cdctriggerneuroconfig
DBObjPtr< CDCTriggerNeuroConfig > m_cdctriggerneuroconfig
get NNT payload from database.
Definition: NeuroTrigger.h:286
Belle2::NeuroTrigger::m_idRef
double m_idRef[9][2]
2D phi position of current track scaled to number of wires
Definition: NeuroTrigger.h:263
Belle2::NeuroTrigger::Parameters::tMax
unsigned tMax
Maximal drift time, identical for all networks.
Definition: NeuroTrigger.h:88
Belle2::NeuroTrigger::getEventTime
void getEventTime(unsigned isector, const CDCTriggerTrack &track, std::string et_option, const bool)
Read out the event time and store it.
Definition: NeuroTrigger.cc:384
Belle2::NeuroTrigger::Parameters::phiRange
std::vector< std::vector< float > > phiRange
Phi region for which MLP is used in degree for all networks.
Definition: NeuroTrigger.h:58
Belle2::NeuroTrigger::m_T0
int m_T0
Event time of current event / track.
Definition: NeuroTrigger.h:267
Belle2::NeuroTrigger::Parameters::nMLP
unsigned nMLP
Number of networks.
Definition: NeuroTrigger.h:43
Belle2::NeuroTrigger::m_segmentHits
StoreArray< CDCTriggerSegmentHit > m_segmentHits
StoreArray containing the input track segment hits.
Definition: NeuroTrigger.h:280
Belle2::NeuroTrigger::m_hasT0
bool m_hasT0
Flag to show if stored event time is valid.
Definition: NeuroTrigger.h:269
Belle2::NeuroTrigger::Parameters::SLpatternMask
std::vector< unsigned long > SLpatternMask
Super layer pattern mask for which MLP is trained for all networks.
Definition: NeuroTrigger.h:86
Belle2::NeuroTrigger::setConstants
void setConstants()
Loads parameters from the geometry and precalculates some constants that will be needed.
Definition: NeuroTrigger.cc:234
Belle2::NeuroTrigger::m_alpha
double m_alpha[9][2]
2D crossing angle of current track
Definition: NeuroTrigger.h:265
Belle2::NeuroTrigger::Parameters::nHidden
std::vector< std::vector< float > > nHidden
Number of nodes in each hidden layer for all networks or factor to multiply with number of inputs.
Definition: NeuroTrigger.h:48
Belle2::CDCTriggerTrack
Track created by the CDC trigger.
Definition: CDCTriggerTrack.h:15
Belle2::NeuroTrigger::runMLP
std::vector< float > runMLP(unsigned isector, std::vector< float > input)
Run an expert MLP.
Definition: NeuroTrigger.cc:893
Belle2::NeuroTrigger::getInputPattern
unsigned long getInputPattern(unsigned isector, const CDCTriggerTrack &track, const bool neurotrackinputmode)
Calculate input pattern for MLP.
Definition: NeuroTrigger.cc:581
Belle2::NeuroTrigger::Parameters::maxHitsPerSL
std::vector< unsigned short > maxHitsPerSL
Maximum number of hits in a single super layer for all networks.
Definition: NeuroTrigger.h:73
Belle2::NeuroTrigger::get_et_option
std::string get_et_option()
Return value of m_et_option.
Definition: NeuroTrigger.h:203
Belle2::NeuroTrigger::m_eventTime
StoreObjPtr< BinnedEventT0 > m_eventTime
StoreObjPtr containing the event time.
Definition: NeuroTrigger.h:282
Belle2::NeuroTrigger::Parameters::T0fromHits
bool T0fromHits
DEPRECATED!! If true, determine event time from relevant hits if it is missing.
Definition: NeuroTrigger.h:104
Belle2::NeuroTrigger::Parameters::thetaRange
std::vector< std::vector< float > > thetaRange
Theta region for which MLP is used in degree for all networks.
Definition: NeuroTrigger.h:62
Belle2::NeuroTrigger::getRangeIndices
std::vector< unsigned > getRangeIndices(const Parameters &p, unsigned isector)
Get indices for sector ranges in parameter lists.
Definition: NeuroTrigger.cc:216
Belle2::DBObjPtr
Class for accessing objects in the database.
Definition: DBObjPtr.h:31
Belle2::NeuroTrigger::getRelId
double getRelId(const CDCTriggerSegmentHit &hit)
Calculate phi position of a hit relative to 2D track (scaled to number of wires).
Definition: NeuroTrigger.cc:372
Belle2::NeuroTrigger::Parameters::invptRangeTrain
std::vector< std::vector< float > > invptRangeTrain
Charge / Pt region for which MLP is trained in 1/GeV for all networks.
Definition: NeuroTrigger.h:68
Belle2::NeuroTrigger::Parameters::targetZ
bool targetZ
train z as output
Definition: NeuroTrigger.h:50
Belle2::NeuroTrigger::selectHits
std::vector< unsigned > selectHits(unsigned isector, const CDCTriggerTrack &track, bool returnAllRelevant=false)
Select best hits for each super layer.
Definition: NeuroTrigger.cc:722
Belle2::NeuroTrigger::Parameters::invptRange
std::vector< std::vector< float > > invptRange
Charge / Pt region for which MLP is used in 1/GeV for all networks.
Definition: NeuroTrigger.h:60
Belle2::NeuroTrigger
Class to represent the CDC Neurotrigger.
Definition: NeuroTrigger.h:31
Belle2::NeuroTrigger::selectMLPbyPattern
int selectMLPbyPattern(std::vector< int > &MLPs, unsigned long pattern, const bool neurotrackinputmode)
Select one MLP from a list of sector indices.
Definition: NeuroTrigger.cc:288
Belle2
Abstract base class for different kinds of events.
Definition: MillepedeAlgorithm.h:19
Belle2::NeuroTrigger::setPrecision
void setPrecision(std::vector< unsigned > precision)
set fixed point precision
Definition: NeuroTrigger.h:137
Belle2::NeuroTrigger::operator[]
const CDCTriggerMLP & operator[](unsigned index) const
return const reference to a neural network
Definition: NeuroTrigger.h:146
Belle2::StoreObjPtr
Type-safe access to single objects in the data store.
Definition: ParticleList.h:33
Belle2::NeuroTrigger::Parameters::targetTheta
bool targetTheta
train theta as output
Definition: NeuroTrigger.h:52
Belle2::NeuroTrigger::m_MLPs
std::vector< CDCTriggerMLP > m_MLPs
List of networks.
Definition: NeuroTrigger.h:257
Belle2::NeuroTrigger::addMLP
void addMLP(const CDCTriggerMLP &newMLP)
add an MLP to the list of networks
Definition: NeuroTrigger.h:152
Belle2::NeuroTrigger::runMLPFix
std::vector< float > runMLPFix(unsigned isector, std::vector< float > input)
Run an expert MLP with fixed point arithmetic.
Definition: NeuroTrigger.cc:922
Belle2::NeuroTrigger::Parameters::et_option
std::string et_option
Determine, how the event time should be obtained.
Definition: NeuroTrigger.h:102
Belle2::NeuroTrigger::m_radius
double m_radius[9][2]
Radius of the CDC layers with priority wires (2 per super layer)
Definition: NeuroTrigger.h:259
Belle2::NeuroTrigger::nSectors
unsigned nSectors() const
return number of neural networks
Definition: NeuroTrigger.h:149
Belle2::NeuroTrigger::updateTrackFix
void updateTrackFix(const CDCTriggerTrack &track)
Calculate 2D phi position and arclength for the given track and store them.
Definition: NeuroTrigger.cc:341
Belle2::NeuroTrigger::Parameters::phiRangeTrain
std::vector< std::vector< float > > phiRangeTrain
Phi region for which MLP is trained in degree for all networks.
Definition: NeuroTrigger.h:65
Belle2::NeuroTrigger::Parameters::outputScale
std::vector< std::vector< float > > outputScale
Output scale for all networks.
Definition: NeuroTrigger.h:56
Belle2::NeuroTrigger::~NeuroTrigger
virtual ~NeuroTrigger()
Default destructor.
Definition: NeuroTrigger.h:112
Belle2::NeuroTrigger::m_hitCollectionName
std::string m_hitCollectionName
Name of the StoreArray containing the input track segment hits.
Definition: NeuroTrigger.h:284
Belle2::NeuroTrigger::Parameters::multiplyHidden
bool multiplyHidden
If true, multiply nHidden with number of input nodes.
Definition: NeuroTrigger.h:54
Belle2::NeuroTrigger::NeuroTrigger
NeuroTrigger()
Default constructor.
Definition: NeuroTrigger.h:109
Belle2::NeuroTrigger::selectMLPs
std::vector< int > selectMLPs(float phi0, float invpt, float theta)
Select all matching expert MLPs based on the given track parameters.
Definition: NeuroTrigger.cc:261
Belle2::NeuroTrigger::m_TSoffset
unsigned m_TSoffset[10]
Number of track segments up to super layer.
Definition: NeuroTrigger.h:261
Belle2::NeuroTrigger::load
bool load(const std::string &filename, const std::string &arrayname="MLPs")
Load MLPs from file.
Definition: NeuroTrigger.cc:997
Belle2::StoreArray
Accessor to arrays stored in the data store.
Definition: ECLMatchingPerformanceExpertModule.h:33
Belle2::NeuroTrigger::Parameters
Struct to keep neurotrigger parameters.
Definition: NeuroTrigger.h:37
Belle2::NeuroTrigger::initializeCollections
void initializeCollections(std::string hitCollectionName, std::string eventTimeName, std::string et_option)
set the hit collection and event time to required and store the hit collection name
Definition: NeuroTrigger.cc:251
Belle2::NeuroTrigger::Parameters::thetaRangeTrain
std::vector< std::vector< float > > thetaRangeTrain
Theta region for which MLP is trained in degree for all networks.
Definition: NeuroTrigger.h:71
Belle2::NeuroTrigger::save
void save(const std::string &filename, const std::string &arrayname="MLPs")
Save MLPs to file.
Definition: NeuroTrigger.cc:982
Belle2::CDCTriggerSegmentHit
Combination of several CDCHits to a track segment hit for the trigger.
Definition: CDCTriggerSegmentHit.h:16
Belle2::NeuroTrigger::Parameters::SLpattern
std::vector< unsigned long > SLpattern
Super layer pattern for which MLP is trained for all networks.
Definition: NeuroTrigger.h:79
Belle2::NeuroTrigger::getInputVector
std::vector< float > getInputVector(unsigned isector, const std::vector< unsigned > &hitIds)
Calculate input values for MLP.
Definition: NeuroTrigger.cc:860
Belle2::CDCTriggerMLP
Class to keep all parameters of an expert MLP for the neuro trigger.
Definition: CDCTriggerMLP.h:13
Belle2::NeuroTrigger::initialize
void initialize(const Parameters &p)
Set parameters and get some network independent parameters.
Definition: NeuroTrigger.cc:20
Belle2::NeuroTrigger::selectHitsHWSim
std::vector< unsigned > selectHitsHWSim(unsigned isector, const CDCTriggerTrack &track)
Select hits for each super layer from the ones related to input track.
Definition: NeuroTrigger.cc:647
Belle2::NeuroTrigger::m_precision
std::vector< unsigned > m_precision
Fixed point precision in bit after radix point.
Definition: NeuroTrigger.h:277