MCParticleHarvester Class Reference

Inheritance diagram for MCParticleHarvester:

Collaboration diagram for MCParticleHarvester:

Public Member Functions
def	__init__ (self)
def	pick (self, mc_particle)
def	generate_cluster_dicts (self, charge_list, path_length_list, normalized_charge_list, name)
def	peel (self, mc_particle)
def	id (self)
def	initialize (self)
def	event (self)
def	terminate (self)
def	barn (self)
def	gather (self)
def	prepare (self)
def	refine (self, crops)

Static Public Member Functions
def	create_crop_part_collection ()
def	iter_store_obj (store_obj)

Public Attributes
	foreach
	Name of the StoreArray or iterable StoreObjPtr that contains the objects to be harvested.
	output_file_name
	Name of the ROOT output file to be generated.
	title
	Name of this harvest. More...
	contact
	Contact email address to be displayed on the validation page.
	expert_level
	Integer expert level that controlls to detail of plots to be generated.
	refiners
	A list of additional refiner instances to be executed on top of the refiner methods that are members of this class.
	show_results
	Switch to show the result ROOT file in a TBrowser on terminate.
	stash
	stash of the harvested crops (start with those in the barn)
	raw_crops
	the dictionaries from peel as a numpy.array of doubles
	crops
	the dictionaries from peel

Static Public Attributes
	save_tree = refiners.SaveTreeRefiner()
	Refiners to be executed at the end of the harvesting / termination of the module Save a tree of all collected variables in a sub folder.
int	default_expert_level = 1
	The default value of expert_level if not specified explicitly by the caller.

Detailed Description

 A harvester to redo parts of the analysis in the Belle II Paper by Robert 

Definition at line 85 of file harvester.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Constructor

Definition at line 89 of file harvester.py.

Member Function Documentation

barn()

def barn (   self )

inherited

Coroutine that receives the dictionaries of names and values from peel and store them.

Reimplemented in PickleHarvestingModule.

Definition at line 289 of file harvesting.py.

create_crop_part_collection()

def 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 281 of file harvesting.py.

event()

def 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 deside 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 241 of file harvesting.py.

gather()

def 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 334 of file harvesting.py.

generate_cluster_dicts()

def generate_cluster_dicts	(		self,
			charge_list,
			path_length_list,
			normalized_charge_list,
			name
	)

Create a dictionary from the lists of charges, normalized charges, and path lengths of the
   clusters associated with an MCParticle

Definition at line 101 of file harvester.py.

id()

def id (   self )

inherited

Working around that name() is a method.

Exposing the name as a property using a different name

Definition at line 226 of file harvesting.py.

initialize()

def initialize (   self )

inherited

Initialisation method of the module.

Prepares the receiver stash of objects to be harvestered.

Definition at line 233 of file harvesting.py.

iter_store_obj()

def iter_store_obj (   store_obj )

staticinherited

Obtain a iterator from a StoreObj

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

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

Definition at line 452 of file harvesting.py.

peel()

def peel	(		self,
			mc_particle
	)

Aggregate the PXD and SVD cluster information for an MCParticle

Reimplemented from HarvestingModule.

Definition at line 122 of file harvester.py.

pick()

def pick	(		self,
			mc_particle
	)

Select the MCParticle if it is a primary pion and has some PXD and/or SVD clusters

Reimplemented from HarvestingModule.

Definition at line 93 of file harvester.py.

prepare()

def prepare (   self )

inherited

Default implementation of prepare.

Can be overridden by subclasses.

Reimplemented in FitValidationModule, and SegmentFakeRatesModule.

Definition at line 373 of file harvesting.py.

refine()

def refine (   self,   crops  )

inherited

Receive the gathered crops and forward them to the refiners.

Reimplemented in PickleHarvestingModule.

Definition at line 407 of file harvesting.py.

terminate()

def terminate (   self )

inherited

Termination method of the module.

Finalize the collected crops.
Start the refinement.

Definition at line 265 of file harvesting.py.

Member Data Documentation

title

title

inherited

Name of this harvest.

Title particle of this harvest

Definition at line 210 of file harvesting.py.

---

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

• tracking/studies/low_momentum_vxd_estimation/harvester.py