VxdCdcMergerHarvesterMCSide Class Reference

Inheritance diagram for VxdCdcMergerHarvesterMCSide:

Collaboration diagram for VxdCdcMergerHarvesterMCSide:

Public Member Functions
def	__init__ (self, output_file_name)
def	pick (self, mc_particle)
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
	mc_track_matcher_cdc
	matcher used for the MCTracks from the CDC
	mc_track_matcher_vxd
	matcher used for the MCTracks from the VXD
	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()
	Save the results dictionary to the output ROOT file.
int	default_expert_level = 1
	The default value of expert_level if not specified explicitly by the caller.

Detailed Description

Gather the MC VXD-CDC-merger results into ROOT file

Definition at line 9 of file validation.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			output_file_name
	)

Init harvester
Arguments:
    output_file_name (str): name of the output ROOT file

Definition at line 12 of file validation.py.

    def __init__(self, output_file_name):
        """
        Init harvester
        Arguments:
            output_file_name (str): name of the output ROOT file
        """
        HarvestingModule.__init__(self, foreach="MCParticles", output_file_name=output_file_name)
 
        
        self.mc_track_matcher_cdc = Belle2.TrackMatchLookUp("MCRecoTracks", "CDCRecoTracks")
        
        self.mc_track_matcher_vxd = Belle2.TrackMatchLookUp("MCRecoTracks", "SVDRecoTracks")
 

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

    def barn(self):
        """Coroutine that receives the dictionaries of names and values from peel and store them."""
        crop = (yield)
        raw_crops = copy.copy(crop)
        crops = copy.copy(crop)
 
        if isinstance(crop, numbers.Number):
            raw_crops = self.create_crop_part_collection()
            try:
                while True:
                    raw_crops.append(crop)
                    # next crop
                    crop = (yield)
            except GeneratorExit:
                crops = np.array(raw_crops)
 
        elif isinstance(crop, collections.MutableMapping):
            for part_name in crop:
                raw_crops[part_name] = self.create_crop_part_collection()
 
            try:
                while True:
                    for part_name, parts in list(raw_crops.items()):
                        if part_name in crop:
                            parts.append(crop[part_name])
                        else:
                            parts.append(np.NaN)
                    # next crop
                    crop = (yield)
            except GeneratorExit:
                for part_name, parts in list(raw_crops.items()):
                    crops[part_name] = np.array(parts)
 
        else:
            msg = "Unrecognised crop {} of type {}".format(
                crop,
                type(crop)
            )
            raise ValueError(msg)
 
        
        self.raw_crops = raw_crops
        
        self.crops = crops
 

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 272 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 232 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 325 of file harvesting.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 217 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 224 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 443 of file harvesting.py.

peel()

def peel	(		self,
			mc_particle
	)

Collect information related to the MCParticle into a dictionary

Reimplemented from HarvestingModule.

Definition at line 35 of file validation.py.

pick()

def pick	(		self,
			mc_particle
	)

Return true if the MCParticle has a related MCRecoTrack

Reimplemented from HarvestingModule.

Definition at line 25 of file validation.py.

prepare()

def prepare (   self )

inherited

Default implementation of prepare.

Can be overridden by subclasses.

Reimplemented in SegmentFakeRatesModule, and FitValidationModule.

Definition at line 364 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 398 of file harvesting.py.

terminate()

def terminate (   self )

inherited

Termination method of the module.

Finalize the collected crops.
Start the refinement.

Definition at line 256 of file harvesting.py.

Member Data Documentation

title

title

inherited

Name of this harvest.

Title particle of this harvest

Definition at line 194 of file harvesting.py.

---

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

• tracking/ckf/scripts/ckf/validation.py