Inheritance diagram for ClusterFilterValidationModule:

Public Member Functions
	__init__ (self, output_file_name)

	initialize (self)

	terminate (self)

	prepare (self)

	pick (self, facet)

	peel (self, cluster)

	id (self)

	event (self)

	barn (self)

	gather (self)

	refine (self, crops)

Static Public Member Functions
	create_crop_part_collection ()

	iter_store_obj (store_obj)

Public Attributes
	mc_hit_lookup = Belle2.TrackFindingCDC.CDCMCHitLookUp.getInstance()
	reference to the CDCMCHitlookUp singleton

	cluster_varset = Belle2.TrackFindingCDC.CDCWireHitClusterVarSet()
	reference to the CDCWireHitClusterVarSet

	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
	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.

	save_histograms
	Save histograms in a sub folder.

int	default_expert_level = 1
	The default value of expert_level if not specified explicitly by the caller.

Detailed Description

Module to collect information about the facet creation cuts and compose validation plots on terminate.

Definition at line 66 of file clusterFilterValidation.py.

Constructor & Destructor Documentation

◆ init()

__init__	(		self,
			output_file_name )

Constructor

Definition at line 70 of file clusterFilterValidation.py.

    def __init__(self, output_file_name):
        """Constructor"""
        super().__init__(foreach="CDCWireHitClusterVector",
                         output_file_name=output_file_name)
        ## reference to the CDCMCHitlookUp singleton
        self.mc_hit_lookup = Belle2.TrackFindingCDC.CDCMCHitLookUp.getInstance()
        ## reference to the CDCWireHitClusterVarSet
        self.cluster_varset = Belle2.TrackFindingCDC.CDCWireHitClusterVarSet()
 

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.

    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.abc.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 = f"Unrecognised crop {crop} of type {type(crop)}"
            raise ValueError(msg)
 
        
        self.raw_crops = raw_crops
        
        self.crops = crops
 

◆ 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.

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

◆ 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.

    def event(self):
        """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
        """
        self.prepare()
        stash = self.stash.send
        pick = self.pick
        peel = self.peel
        for crop in self.gather():
            if pick(crop):
                crop = peel(crop)
                if isinstance(crop, types.GeneratorType):
                    many_crops = crop
                    for crop in many_crops:
                        stash(crop)
                else:
                    stash(crop)
 

◆ 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.

    def gather(self):
        """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.
        """
 
        registered_store_arrays = Belle2.PyStoreArray.list()
        registered_store_objs = Belle2.PyStoreObj.list()
 
        foreach = self.foreach
        foreach_is_store_obj = foreach in registered_store_objs
        foreach_is_store_array = foreach in registered_store_arrays
 
        if foreach is not None:
            if foreach_is_store_array:
                store_array = Belle2.PyStoreArray(self.foreach)
                yield from store_array
 
            elif foreach_is_store_obj:
                store_obj = Belle2.PyStoreObj(self.foreach)
                try:
                    yield from self.iter_store_obj(store_obj)
                except TypeError:
                    # Cannot iter the store object. Yield it instead.
                    yield store_obj.obj()
 
            else:
                msg = f"Name {self.foreach} does not refer to a valid object on the data store"
                raise KeyError(msg)
        else:
            yield None
 

◆ 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.

    def id(self):
        """Working around that name() is a method.
 
        Exposing the name as a property using a different name
        """
        return self.name()
 

◆ initialize()

initialize ( self )

Receive signal at the start of event processing

Reimplemented from HarvestingModule.

Definition at line 79 of file clusterFilterValidation.py.

    def initialize(self):
        """Receive signal at the start of event processing"""
        self.cluster_varset.initialize()
        super().initialize()
 

◆ 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.

    def iter_store_obj(store_obj):
        """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
        """
        iterable = store_obj.obj()
        last_iterable = None
        while iterable is not last_iterable:
            if hasattr(iterable, "__iter__"):
                iterable, last_iterable = iterable.__iter__(), iterable
            else:
                iterable, last_iterable = iter(iterable), iterable
        return iterable
 
 

◆ peel()

peel	(		self,
			cluster )

Extract and store CDC hit and cluster information

Reimplemented from HarvestingModule.

Definition at line 97 of file clusterFilterValidation.py.

    def peel(self, cluster):
        """Extract and store CDC hit and cluster information"""
 
        mc_hit_lookup = self.mc_hit_lookup
 
        self.cluster_varset.extract(cluster)
        cluster_crops = self.cluster_varset.getNamedValues()
        cluster_crops = dict(cluster_crops)
 
        # Truth variables
        n_background = 0
        for wireHit in list(cluster.items()):
            cdcHit = wireHit.getHit()
            if mc_hit_lookup.isBackground(cdcHit):
                n_background += 1
 
        truth_dict = dict(
            n_background_truth=n_background,
            background_fraction_truth=1.0 * n_background / cluster.size()
        )
 
        cluster_crops.update(truth_dict)
        return cluster_crops
 

◆ pick()

pick	(		self,
			facet )

Always pick, never reject

Reimplemented from HarvestingModule.

Definition at line 93 of file clusterFilterValidation.py.

    def pick(self, facet):
        """Always pick, never reject"""
        return True
 

◆ prepare()

prepare ( self )

Fill the MC hit table

Reimplemented from HarvestingModule.

Definition at line 89 of file clusterFilterValidation.py.

    def prepare(self):
        """Fill the MC hit table"""
        self.mc_hit_lookup.fill()
 

◆ 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.

    def refine(self, crops):
        """Receive the gathered crops and forward them to the refiners."""
 
        kwds = {}
        if self.output_file_name:
            # Save everything to a ROOT file
            if isinstance(self.output_file_name, ROOT.TFile):
                output_tdirectory = self.output_file_name
            else:
                output_tfile = ROOT.TFile(self.output_file_name, 'recreate')
                output_tdirectory = output_tfile
 
        else:
            output_tdirectory = None
 
        try:
            with root_cd(output_tdirectory):
                for refiner in self.refiners:
                    refiner(self, crops, tdirectory=output_tdirectory, **kwds)
 
                # Get the methods marked as refiners from the class
                cls = type(self)
                for name in dir(cls):
                    if isinstance(getattr(cls, name), Refiner):
                        refiner = getattr(self, name)
                        # Getattr already binds self
                        refiner(crops, tdirectory=output_tdirectory, **kwds)
 
        finally:
            # If we opened the TFile ourself, close it again
            if self.output_file_name:
                if isinstance(self.output_file_name, str):
                    output_tfile.Close()
 
        if self.show_results and self.output_file_name:
            if isinstance(self.output_file_name, str):
                output_tfile = ROOT.TFile(self.output_file_name)
                root_browse(output_tfile)
                input("Press enter to close")
                output_tfile.Close()
            else:
                root_browse(self.output_file_name)
                input("Press enter to close")
 

◆ terminate()

terminate ( self )

Receive signal at the end of event processing

Reimplemented from HarvestingModule.

Definition at line 84 of file clusterFilterValidation.py.

    def terminate(self):
        """Receive signal at the end of event processing"""
        self.cluster_varset.terminate()
        super().terminate()
 

Member Data Documentation

◆ cluster_varset

cluster_varset = Belle2.TrackFindingCDC.CDCWireHitClusterVarSet()

reference to the CDCWireHitClusterVarSet

Definition at line 77 of file clusterFilterValidation.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_hit_lookup

mc_hit_lookup = Belle2.TrackFindingCDC.CDCMCHitLookUp.getInstance()

reference to the CDCMCHitlookUp singleton

Definition at line 75 of file clusterFilterValidation.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.

◆ 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_histograms

save_histograms

static

Initial value:

=  refiners.save_histograms(
        
    )

Save histograms in a sub folder.

Definition at line 129 of file clusterFilterValidation.py.

◆ save_tree

save_tree

static

Initial value:

=  refiners.save_tree(
        
    )

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.

Definition at line 123 of file clusterFilterValidation.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.

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

tracking/trackFindingCDC/studies/clusterFilter/clusterFilterValidation.py

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ barn()

◆ create_crop_part_collection()

◆ event()

◆ gather()

◆ id()

◆ initialize()

◆ iter_store_obj()

◆ peel()

◆ pick()

◆ prepare()

◆ refine()

◆ terminate()

Member Data Documentation

◆ cluster_varset

◆ contact

◆ crops

◆ default_expert_level

◆ expert_level

◆ foreach

◆ mc_hit_lookup

◆ output_file_name

◆ raw_crops

◆ refiners

◆ save_histograms

◆ save_tree

◆ show_results

◆ stash

◆ title

◆ init()