![]() |
Belle II Software development
|
Public Member Functions | |
__init__ (self, queue, foreach, output_file_name, name=None, title=None, contact=None, expert_level=None) | |
id (self) | |
initialize (self) | |
event (self) | |
terminate (self) | |
barn (self) | |
gather (self) | |
prepare (self) | |
peel (self, crop) | |
pick (self, crop) | |
refine (self, crops) | |
Static Public Member Functions | |
create_crop_part_collection () | |
iter_store_obj (store_obj) | |
Public Attributes | |
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 | |
int | default_expert_level = 1 |
The default value of expert_level if not specified explicitly by the caller. | |
Wrapper for the HarvestingModule to write its output file name to the queue
Definition at line 75 of file wrapper.py.
__init__ | ( | self, | |
queue, | |||
foreach, | |||
output_file_name, | |||
name = None, | |||
title = None, | |||
contact = None, | |||
expert_level = None ) |
The same as the base class except for the queue argument
Definition at line 79 of file wrapper.py.
|
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.
|
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.
|
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.
|
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.
|
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.
|
inherited |
Initialisation method of the module. Prepares the receiver stash of objects to be harvestered.
Reimplemented in ClusterFilterValidationModule, ElossHarvestingModule, LegendreBinningValidationModule, SegmentFitValidationModule, Saving1stMVAData, Saving2ndMVAData, SegmentPairCreationValidationModule, EventwiseTrackingValidationModule, MCSideTrackingValidationModule, and PRSideTrackingValidationModule.
Definition at line 231 of file harvesting.py.
|
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.
|
inherited |
Unpack the the instances and return and dictionary of names to values or a generator of those dictionaries to be saved. Returns ------- dict(str -> float) Unpacked names and values or Yields ------ dict(str -> float) Unpacked names and values
Reimplemented in VxdCdcMergerHarvesterMCSide, VxdCdcMergerHarvesterPRSide, ClusterFilterValidationModule, FitValidationModule, VxdCdcPartFinderHarvester, MCParticleHarvester, MCTrajectoryHarvester, ReconstructionPositionHarvester, SeedsAnalyser, SegmentFakeRatesModule, SegmentFinderParameterExtractorModule, WrongRLInfoCounter, ElossHarvestingModule, LegendreBinningValidationModule, SegmentFitValidationModule, Saving1stMVAData, Saving2ndMVAData, SegmentPairCreationValidationModule, SummarizeTriggerResults, SummarizeTriggerVariables, EventwiseTrackingValidationModule, MCSideTrackingValidationModule, PRSideTrackingValidationModule, EventInfoHarvester, HitInfoHarvester, TrackInfoHarvester, and VxdCdcMergerHarvester.
Definition at line 371 of file harvesting.py.
|
inherited |
Indicate whether the instance should be forwarded to the peeling Returns ------- bool : Indicator if the instance is valuable in the current harvest.
Reimplemented in VxdCdcMergerHarvesterMCSide, ClusterFilterValidationModule, MCParticleHarvester, ElossHarvestingModule, LegendreBinningValidationModule, SegmentFitValidationModule, Saving1stMVAData, Saving2ndMVAData, SegmentPairCreationValidationModule, EventwiseTrackingValidationModule, MCSideTrackingValidationModule, PRSideTrackingValidationModule, and VxdCdcMergerHarvester.
Definition at line 389 of file harvesting.py.
|
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.
|
inherited |
Receive the gathered crops and forward them to the refiners.
Reimplemented in PickleHarvestingModule.
Definition at line 398 of file harvesting.py.
|
inherited |
Termination method of the module. Finalize the collected crops. Start the refinement.
Reimplemented in ClusterFilterValidationModule.
Definition at line 263 of file harvesting.py.
|
inherited |
Contact email address to be displayed on the validation page.
Definition at line 211 of file harvesting.py.
|
inherited |
the dictionaries from peel
Definition at line 274 of file harvesting.py.
|
staticinherited |
The default value of expert_level if not specified explicitly by the caller.
Definition at line 156 of file harvesting.py.
|
inherited |
Integer expert level that controls to detail of plots to be generated.
Definition at line 214 of file harvesting.py.
|
inherited |
Name of the StoreArray or iterable StoreObjPtr that contains the objects to be harvested.
Definition at line 196 of file harvesting.py.
|
inherited |
Name of the ROOT output file to be generated.
Definition at line 199 of file harvesting.py.
|
inherited |
the dictionaries from peel as a numpy.array of doubles
Definition at line 325 of file harvesting.py.
|
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.
|
inherited |
Switch to show the result ROOT file in a TBrowser on terminate.
Definition at line 221 of file harvesting.py.
|
inherited |
stash of the harvested crops (start with those in the barn)
Definition at line 237 of file harvesting.py.
|
inherited |