Belle II Software prerelease-10-00-00a
EventwiseTrackingValidationModule Class Reference
Inheritance diagram for EventwiseTrackingValidationModule:
Collaboration diagram for EventwiseTrackingValidationModule:

Public Member Functions

 __init__ (self, name, contact, output_file_name=None, reco_tracks_name='RecoTracks', mc_reco_tracks_name='MCRecoTracks', expert_level=None)
 
 initialize (self)
 
 pick (self, event_meta_data=None)
 
 peel (self, event_meta_data=None)
 
 id (self)
 
 event (self)
 
 terminate (self)
 
 barn (self)
 
 gather (self)
 
 prepare (self)
 
 refine (self, crops)
 

Static Public Member Functions

 create_crop_part_collection ()
 
 iter_store_obj (store_obj)
 

Public Attributes

 reco_tracks_name = reco_tracks_name
 cached value of the RecoTracks collection name
 
 mc_reco_tracks_name = mc_reco_tracks_name
 cached value of the MCRecoTracks collection name
 
str cdc_hits_name = "CDCHits"
 cached value of the CDCHits collection name
 
 track_match_look_up
 Reference to the track-match object that examines relation information from MCMatcherTracksModule.
 
 foreach = foreach
 Name of the StoreArray or iterable StoreObjPtr that contains the objects to be harvested.
 
 output_file_name = output_file_name
 Name of the ROOT output file to be generated.
 
 title = title or self.name()
 Name of this harvest.
 
 contact = contact
 Contact email address to be displayed on the validation page.
 
int expert_level = self.default_expert_level if expert_level is None else expert_level
 Integer expert level that controls to detail of plots to be generated.
 
list refiners = []
 A list of additional refiner instances to be executed on top of the refiner methods that are members of this class.
 
 show_results = show_results
 Switch to show the result ROOT file in a TBrowser on terminate.
 
 stash = self.barn()
 stash of the harvested crops (start with those in the barn)
 
 crops
 the dictionaries from peel
 
 raw_crops = raw_crops
 the dictionaries from peel as a numpy.array of doubles
 

Static Public Attributes

 save_tree
 Save a tree of all collected variables in a sub folder.
 
 save_clone_rate
 Save selected hit counters.
 
int default_expert_level = 1
 The default value of expert_level if not specified explicitly by the caller.
 

Detailed Description

Module to perform event-by-event tracking validation.
 Expert level behavior:
    expert_level <= default_expert_level: all figures and plots from this module except tree entries
    expert_level > default_expert_level: everything including tree entries

Definition at line 21 of file eventwise_module.py.

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
name,
contact,
output_file_name = None,
reco_tracks_name = 'RecoTracks',
mc_reco_tracks_name = 'MCRecoTracks',
expert_level = None )
Constructor

Definition at line 32 of file eventwise_module.py.

38 expert_level=None):
39 """Constructor"""
40
41 output_file_name = output_file_name or name + 'TrackingValidation.root'
42
43 super().__init__(foreach="EventMetaData", # Dummy for on element per event
44 name=name,
45 output_file_name=output_file_name,
46 contact=contact,
47 expert_level=expert_level)
48
49 ## cached value of the RecoTracks collection name
50 self.reco_tracks_name = reco_tracks_name
51 ## cached value of the MCRecoTracks collection name
52 self.mc_reco_tracks_name = mc_reco_tracks_name
53 ## cached value of the CDCHits collection name
54 self.cdc_hits_name = "CDCHits"
55

Member Function Documentation

◆ barn()

barn ( self)
inherited
Coroutine that receives the dictionaries of names and values from peel and store them.

Reimplemented in PickleHarvestingModule.

Definition at line 287 of file harvesting.py.

287 def barn(self):
288 """Coroutine that receives the dictionaries of names and values from peel and store them."""
289 crop = (yield)
290 raw_crops = copy.copy(crop)
291 crops = copy.copy(crop)
292
293 if isinstance(crop, numbers.Number):
294 raw_crops = self.create_crop_part_collection()
295 try:
296 while True:
297 raw_crops.append(crop)
298 # next crop
299 crop = (yield)
300 except GeneratorExit:
301 crops = np.array(raw_crops)
302
303 elif isinstance(crop, collections.abc.MutableMapping):
304 for part_name in crop:
305 raw_crops[part_name] = self.create_crop_part_collection()
306
307 try:
308 while True:
309 for part_name, parts in list(raw_crops.items()):
310 if part_name in crop:
311 parts.append(crop[part_name])
312 else:
313 parts.append(np.NaN)
314 # next crop
315 crop = (yield)
316 except GeneratorExit:
317 for part_name, parts in list(raw_crops.items()):
318 crops[part_name] = np.array(parts)
319
320 else:
321 msg = f"Unrecognised crop {crop} of type {type(crop)}"
322 raise ValueError(msg)
323
324
325 self.raw_crops = raw_crops
326
327 self.crops = crops
328

◆ create_crop_part_collection()

create_crop_part_collection ( )
staticinherited
Create the storing objects for the crop values

Currently a numpy.array of doubles is used to store all values in memory.

Definition at line 279 of file harvesting.py.

279 def create_crop_part_collection():
280 """Create the storing objects for the crop values
281
282 Currently a numpy.array of doubles is used to store all values in memory.
283 """
284 return array.array("d")
285

◆ event()

event ( self)
inherited
Event method of the module

* Does invoke the prepare method before the iteration starts.
* In each event fetch the StoreArray / iterable StoreObjPtr,
* Iterate through all instances
* Feed each instance to the pick method to decide it the instance is relevant
* Forward it to the peel method that should generated a dictionary of values
* Store each dictionary of values

Definition at line 239 of file harvesting.py.

239 def event(self):
240 """Event method of the module
241
242 * Does invoke the prepare method before the iteration starts.
243 * In each event fetch the StoreArray / iterable StoreObjPtr,
244 * Iterate through all instances
245 * Feed each instance to the pick method to decide it the instance is relevant
246 * Forward it to the peel method that should generated a dictionary of values
247 * Store each dictionary of values
248 """
249 self.prepare()
250 stash = self.stash.send
251 pick = self.pick
252 peel = self.peel
253 for crop in self.gather():
254 if pick(crop):
255 crop = peel(crop)
256 if isinstance(crop, types.GeneratorType):
257 many_crops = crop
258 for crop in many_crops:
259 stash(crop)
260 else:
261 stash(crop)
262

◆ gather()

gather ( self)
inherited
Iterator that yield the instances form the StoreArray / iterable StoreObj.

Yields
------
Object instances from the StoreArray, iterable StoreObj or the StoreObj itself
in case it is not iterable.

Definition at line 329 of file harvesting.py.

329 def gather(self):
330 """Iterator that yield the instances form the StoreArray / iterable StoreObj.
331
332 Yields
333 ------
334 Object instances from the StoreArray, iterable StoreObj or the StoreObj itself
335 in case it is not iterable.
336 """
337
338 registered_store_arrays = Belle2.PyStoreArray.list()
339 registered_store_objs = Belle2.PyStoreObj.list()
340
341 foreach = self.foreach
342 foreach_is_store_obj = foreach in registered_store_objs
343 foreach_is_store_array = foreach in registered_store_arrays
344
345 if foreach is not None:
346 if foreach_is_store_array:
347 store_array = Belle2.PyStoreArray(self.foreach)
348 yield from store_array
349
350 elif foreach_is_store_obj:
351 store_obj = Belle2.PyStoreObj(self.foreach)
352 try:
353 yield from self.iter_store_obj(store_obj)
354 except TypeError:
355 # Cannot iter the store object. Yield it instead.
356 yield store_obj.obj()
357
358 else:
359 msg = f"Name {self.foreach} does not refer to a valid object on the data store"
360 raise KeyError(msg)
361 else:
362 yield None
363
A (simplified) python wrapper for StoreArray.
static std::vector< std::string > list(DataStore::EDurability durability=DataStore::EDurability::c_Event)
Return list of available arrays for given durability.
a (simplified) python wrapper for StoreObjPtr.
Definition PyStoreObj.h:67
static std::vector< std::string > list(DataStore::EDurability durability=DataStore::EDurability::c_Event)
Return list of available objects for given durability.
Definition PyStoreObj.cc:28

◆ id()

id ( self)
inherited
Working around that name() is a method.

Exposing the name as a property using a different name

Definition at line 224 of file harvesting.py.

224 def id(self):
225 """Working around that name() is a method.
226
227 Exposing the name as a property using a different name
228 """
229 return self.name()
230

◆ initialize()

initialize ( self)
Initialization signal at the start of the event processing

Reimplemented from HarvestingModule.

Definition at line 56 of file eventwise_module.py.

56 def initialize(self):
57 """Initialization signal at the start of the event processing"""
58 super().initialize()
59
60 self.track_match_look_up = Belle2.TrackMatchLookUp(self.mc_reco_tracks_name,
61 self.reco_tracks_name)
62
Class to provide convenient methods to look up matching information between pattern recognition and M...

◆ iter_store_obj()

iter_store_obj ( store_obj)
staticinherited
Obtain a iterator from a StoreObj

Repeatedly calls iter(store_obj) or store_obj.__iter__()
until the final iterator returns itself

Returns
-------
iterator of the StoreObj

Definition at line 443 of file harvesting.py.

443 def iter_store_obj(store_obj):
444 """Obtain a iterator from a StoreObj
445
446 Repeatedly calls iter(store_obj) or store_obj.__iter__()
447 until the final iterator returns itself
448
449 Returns
450 -------
451 iterator of the StoreObj
452 """
453 iterable = store_obj.obj()
454 last_iterable = None
455 while iterable is not last_iterable:
456 if hasattr(iterable, "__iter__"):
457 iterable, last_iterable = iterable.__iter__(), iterable
458 else:
459 iterable, last_iterable = iter(iterable), iterable
460 return iterable
461
462

◆ peel()

peel ( self,
event_meta_data = None )
Peel information from the event

Reimplemented from HarvestingModule.

Definition at line 67 of file eventwise_module.py.

67 def peel(self, event_meta_data=None):
68 """Peel information from the event"""
69 # Note event_meta_data is just used as a dummy.
70
71 track_match_look_up = self.track_match_look_up
72 reco_tracks = Belle2.PyStoreArray(self.reco_tracks_name)
73 mc_reco_tracks = Belle2.PyStoreArray(self.mc_reco_tracks_name)
74 cdc_hits = Belle2.PyStoreArray(self.cdc_hits_name)
75 mc_particles = Belle2.PyStoreArray("MCParticles")
76
77 # General object count in the event.
78 if mc_particles:
79 n_mc_particles = mc_particles.getEntries()
80 else:
81 n_mc_particles = -1
82
83 if mc_reco_tracks:
84 n_mc_reco_tracks = mc_reco_tracks.getEntries()
85 else:
86 n_mc_reco_tracks = -1
87
88 n_reco_tracks = reco_tracks.getEntries()
89
90 # Aggregate information about Monte Carlo tracks
91 all_mc_tracks_det_hit_ids = set()
92 n_matched_mc_reco_tracks = 0
93 n_matched_correct_charge_mc_reco_tracks = 0
94 n_matched_wrong_charge_mc_reco_tracks = 0
95 n_merged_mc_reco_tracks = 0
96 n_merged_correct_charge_mc_reco_tracks = 0
97 n_merged_wrong_charge_mc_reco_tracks = 0
98 n_missing_mc_reco_tracks = 0
99 for mc_reco_track in mc_reco_tracks:
100 mc_reco_track_det_hit_ids = utilities.get_det_hit_ids(mc_reco_track)
101 all_mc_tracks_det_hit_ids.update(mc_reco_track_det_hit_ids)
102
103 is_matched = track_match_look_up.isAnyChargeMatchedMCRecoTrack(mc_reco_track)
104 is_matched_correct_charge = track_match_look_up.isCorrectChargeMatchedMCRecoTrack(mc_reco_track)
105 is_matched_wrong_charge = track_match_look_up.isWrongChargeMatchedMCRecoTrack(mc_reco_track)
106 is_merged = track_match_look_up.isAnyChargeMergedMCRecoTrack(mc_reco_track)
107 is_merged_correct_charge = track_match_look_up.isCorrectChargeMergedMCRecoTrack(mc_reco_track)
108 is_merged_wrong_charge = track_match_look_up.isWrongChargeMergedMCRecoTrack(mc_reco_track)
109 is_missing = track_match_look_up.isMissingMCRecoTrack(mc_reco_track)
110
111 if is_matched:
112 n_matched_mc_reco_tracks += 1
113 if is_matched_correct_charge:
114 n_matched_correct_charge_mc_reco_tracks += 1
115 elif is_matched_wrong_charge:
116 n_matched_wrong_charge_mc_reco_tracks += 1
117 elif is_merged:
118 n_merged_mc_reco_tracks += 1
119 if is_merged_correct_charge:
120 n_merged_correct_charge_mc_reco_tracks += 1
121 elif is_merged_wrong_charge:
122 n_merged_wrong_charge_mc_reco_tracks += 1
123 elif is_missing:
124 n_missing_mc_reco_tracks += 1
125
126 # Aggregate information about pattern recognition tracks
127 n_matched_reco_tracks = 0
128 n_matched_correct_charge_reco_tracks = 0
129 n_matched_wrong_charge_reco_tracks = 0
130 n_clone_reco_tracks = 0
131 n_clone_correct_charge_reco_tracks = 0
132 n_clone_wrong_charge_reco_tracks = 0
133 n_background_reco_tracks = 0
134 n_ghost_reco_tracks = 0
135
136 all_tracks_det_hit_ids = set()
137 n_matched_hits = 0
138 for reco_track in reco_tracks:
139 is_matched = track_match_look_up.isAnyChargeMatchedPRRecoTrack(reco_track)
140 is_matched_correct_charge = track_match_look_up.isCorrectChargeMatchedPRRecoTrack(reco_track)
141 is_matched_wrong_charge = track_match_look_up.isWrongChargeMatchedPRRecoTrack(reco_track)
142 is_clone = track_match_look_up.isAnyChargeClonePRRecoTrack(reco_track)
143 is_clone_correct_charge = track_match_look_up.isCorrectChargeClonePRRecoTrack(reco_track)
144 is_clone_wrong_charge = track_match_look_up.isWrongChargeClonePRRecoTrack(reco_track)
145 is_background = track_match_look_up.isBackgroundPRRecoTrack(reco_track)
146 is_ghost = track_match_look_up.isGhostPRRecoTrack(reco_track)
147
148 if is_matched:
149 n_matched_reco_tracks += 1
150 if is_matched_correct_charge:
151 n_matched_correct_charge_reco_tracks += 1
152 elif is_matched_wrong_charge:
153 n_matched_wrong_charge_reco_tracks += 1
154 elif is_clone:
155 n_clone_reco_tracks += 1
156 if is_clone_correct_charge:
157 n_clone_correct_charge_reco_tracks += 1
158 elif is_clone_wrong_charge:
159 n_clone_wrong_charge_reco_tracks += 1
160 elif is_background:
161 n_background_reco_tracks += 1
162 elif is_ghost:
163 n_ghost_reco_tracks += 1
164
165 reco_track_det_hit_ids = utilities.get_det_hit_ids(reco_track)
166
167 all_tracks_det_hit_ids.update(reco_track_det_hit_ids)
168 if is_matched or is_clone:
169 mc_reco_track = self.track_match_look_up.getRelatedMCRecoTrack(reco_track)
170
171 mc_reco_track_det_hit_ids = utilities.get_det_hit_ids(mc_reco_track)
172 n_matched_hits += len(reco_track_det_hit_ids & mc_reco_track_det_hit_ids)
173
174 return dict(
175 n_mc_particles=n_mc_particles,
176 n_mc_reco_tracks=n_mc_reco_tracks,
177 n_reco_tracks=n_reco_tracks,
178
179 n_matched_mc_reco_tracks=n_matched_mc_reco_tracks,
180 n_matched_correct_charge_mc_reco_tracks=n_matched_correct_charge_mc_reco_tracks,
181 n_matched_wrong_charge_mc_reco_tracks=n_matched_wrong_charge_mc_reco_tracks,
182
183 n_merged_mc_reco_tracks=n_merged_mc_reco_tracks,
184 n_merged_correct_charge_mc_reco_tracks=n_merged_correct_charge_mc_reco_tracks,
185 n_merged_wrong_charge_mc_reco_tracks=n_merged_wrong_charge_mc_reco_tracks,
186
187 n_missing_mc_reco_tracks=n_missing_mc_reco_tracks,
188
189
190 n_matched_reco_tracks=n_matched_reco_tracks,
191 n_matched_correct_charge_reco_tracks=n_matched_correct_charge_reco_tracks,
192 n_matched_wrong_charge_reco_tracks=n_matched_wrong_charge_reco_tracks,
193 n_clone_reco_tracks=n_clone_reco_tracks,
194 n_clone_correct_charge_reco_tracks=n_clone_correct_charge_reco_tracks,
195 n_clone_wrong_charge_reco_tracks=n_clone_wrong_charge_reco_tracks,
196
197 n_background_reco_tracks=n_background_reco_tracks,
198 n_ghost_reco_tracks=n_ghost_reco_tracks,
199
200 n_cdc_hits=cdc_hits.getEntries(),
201 n_all_mc_track_hits=len(all_mc_tracks_det_hit_ids),
202 n_all_track_hits=len(all_tracks_det_hit_ids),
203 n_found_hits=len(all_mc_tracks_det_hit_ids & all_tracks_det_hit_ids),
204 n_matched_hits=n_matched_hits
205 )
206

◆ pick()

pick ( self,
event_meta_data = None )
Always pick

Reimplemented from HarvestingModule.

Definition at line 63 of file eventwise_module.py.

63 def pick(self, event_meta_data=None):
64 """Always pick"""
65 return True
66

◆ prepare()

prepare ( self)
inherited
Default implementation of prepare.

Can be overridden by subclasses.

Reimplemented in ClusterFilterValidationModule, FitValidationModule, SegmentFakeRatesModule, ElossHarvestingModule, LegendreBinningValidationModule, SegmentFitValidationModule, Saving1stMVAData, Saving2ndMVAData, SegmentPairCreationValidationModule, MCSideTrackingValidationModule, and PRSideTrackingValidationModule.

Definition at line 364 of file harvesting.py.

364 def prepare(self):
365 """Default implementation of prepare.
366
367 Can be overridden by subclasses.
368 """
369 return
370

◆ refine()

refine ( self,
crops )
inherited
Receive the gathered crops and forward them to the refiners.

Reimplemented in PickleHarvestingModule.

Definition at line 398 of file harvesting.py.

398 def refine(self, crops):
399 """Receive the gathered crops and forward them to the refiners."""
400
401 kwds = {}
402 if self.output_file_name:
403 # Save everything to a ROOT file
404 if isinstance(self.output_file_name, ROOT.TFile):
405 output_tdirectory = self.output_file_name
406 else:
407 output_tfile = ROOT.TFile(self.output_file_name, 'recreate')
408 output_tdirectory = output_tfile
409
410 else:
411 output_tdirectory = None
412
413 try:
414 with root_cd(output_tdirectory):
415 for refiner in self.refiners:
416 refiner(self, crops, tdirectory=output_tdirectory, **kwds)
417
418 # Get the methods marked as refiners from the class
419 cls = type(self)
420 for name in dir(cls):
421 if isinstance(getattr(cls, name), Refiner):
422 refiner = getattr(self, name)
423 # Getattr already binds self
424 refiner(crops, tdirectory=output_tdirectory, **kwds)
425
426 finally:
427 # If we opened the TFile ourself, close it again
428 if self.output_file_name:
429 if isinstance(self.output_file_name, str):
430 output_tfile.Close()
431
432 if self.show_results and self.output_file_name:
433 if isinstance(self.output_file_name, str):
434 output_tfile = ROOT.TFile(self.output_file_name)
435 root_browse(output_tfile)
436 input("Press enter to close")
437 output_tfile.Close()
438 else:
439 root_browse(self.output_file_name)
440 input("Press enter to close")
441

◆ terminate()

terminate ( self)
inherited
Termination method of the module.

Finalize the collected crops.
Start the refinement.

Reimplemented in ClusterFilterValidationModule.

Definition at line 263 of file harvesting.py.

263 def terminate(self):
264 """Termination method of the module.
265
266 Finalize the collected crops.
267 Start the refinement.
268 """
269
270 self.stash.close()
271 del self.stash
272
273 try:
274 self.refine(self.crops)
275 except AttributeError:
276 pass
277

Member Data Documentation

◆ cdc_hits_name

str cdc_hits_name = "CDCHits"

cached value of the CDCHits collection name

Definition at line 54 of file eventwise_module.py.

◆ contact

contact = contact
inherited

Contact email address to be displayed on the validation page.

Definition at line 211 of file harvesting.py.

◆ crops

crops
inherited

the dictionaries from peel

Definition at line 274 of file harvesting.py.

◆ default_expert_level

int default_expert_level = 1
staticinherited

The default value of expert_level if not specified explicitly by the caller.

Definition at line 156 of file harvesting.py.

◆ expert_level

int expert_level = self.default_expert_level if expert_level is None else expert_level
inherited

Integer expert level that controls to detail of plots to be generated.

Definition at line 214 of file harvesting.py.

◆ foreach

foreach = foreach
inherited

Name of the StoreArray or iterable StoreObjPtr that contains the objects to be harvested.

Definition at line 196 of file harvesting.py.

◆ mc_reco_tracks_name

mc_reco_tracks_name = mc_reco_tracks_name

cached value of the MCRecoTracks collection name

Definition at line 52 of file eventwise_module.py.

◆ output_file_name

output_file_name = output_file_name
inherited

Name of the ROOT output file to be generated.

Definition at line 199 of file harvesting.py.

◆ raw_crops

raw_crops = raw_crops
inherited

the dictionaries from peel as a numpy.array of doubles

Definition at line 325 of file harvesting.py.

◆ reco_tracks_name

reco_tracks_name = reco_tracks_name

cached value of the RecoTracks collection name

Definition at line 50 of file eventwise_module.py.

◆ refiners

list refiners = []
inherited

A list of additional refiner instances to be executed on top of the refiner methods that are members of this class.

Definition at line 218 of file harvesting.py.

◆ save_clone_rate

save_clone_rate
static
Initial value:
= refiners.save_fom(
# using cond to suppress false doxygen warnings
)

Save selected hit counters.

Definition at line 221 of file eventwise_module.py.

◆ save_tree

save_tree
static
Initial value:
= refiners.save_tree(
# using cond to suppress false doxygen warnings
)

Save a tree of all collected variables in a sub folder.

Definition at line 211 of file eventwise_module.py.

◆ show_results

show_results = show_results
inherited

Switch to show the result ROOT file in a TBrowser on terminate.

Definition at line 221 of file harvesting.py.

◆ stash

stash = self.barn()
inherited

stash of the harvested crops (start with those in the barn)

Definition at line 237 of file harvesting.py.

◆ title

title = title or self.name()
inherited

Name of this harvest.

Title particle of this harvest

Definition at line 208 of file harvesting.py.

◆ track_match_look_up

track_match_look_up
Initial value:
= Belle2.TrackMatchLookUp(self.mc_reco_tracks_name,
self.reco_tracks_name)

Reference to the track-match object that examines relation information from MCMatcherTracksModule.

Definition at line 60 of file eventwise_module.py.


The documentation for this class was generated from the following file: