Inheritance diagram for PRSideTrackingValidationModule:

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)

	prepare (self)

	pick (self, reco_track)

	peel (self, reco_track)

	peel_pr_to_mc_match_info (self, reco_track)

	id (self)

	event (self)

	terminate (self)

	barn (self)

	gather (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
	Name of the StoreArray of the tracks from pattern recognition.

	mc_reco_tracks_name = mc_reco_tracks_name
	Name of the StoreArray of the ideal mc tracks.

	track_match_look_up = None
	Reference to the track match lookup object reading the relation information constructed by the MCMatcherTracksModule.

list	mc_reco_tracks_det_hit_ids = []
	Cache for the hit content of the Monte Carlo tracks - updated each event.

	mc_hit_lookup = Belle2.TrackFindingCDC.CDCMCHitLookUp.getInstance()
	Cache for the MC hit lookup.

	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 RecoTrack clone-rate information.

	save_clone_rate_by_seed_tan_lambda_profile
	Make profile of the clone rate versus seed tan(lambda) Rename the quantities to names that display nicely by root latex translation.

	save_clone_rate_by_seed_phi0_profile
	Make profile of the clone rate versus seed phi0 Rename the quantities to names that display nicely by root latex translation.

	save_clone_rate_by_seed_pt_profile
	Make profile of the clone rate versus seed transverse momentum Rename the quantities to names that display nicely by root latex translation.

	save_clone_rate_by_seed_pt_profile_groupbyCharge
	Charge dependent histograms Make profile of the clone rate versus seed transverse momentum.

	save_clone_rate_by_seed_tan_lambda_profile_groupbyCharge
	Charge dependent histograms Make profile of the clone rate versus seed tan(lambda)

	save_fake_rate
	Save RecoTrack fake-rate information.

	save_fake_rate_by_seed_phi0_profile
	Make profile of the fake rate versus seed phi0 Rename the quantities to names that display nicely by root latex translation.

	save_fake_rate_by_seed_tan_lambda_profile
	Make profile of the fake rate versus seed tan(lambda) Rename the quantities to names that display nicely by root latex translation.

	save_fake_rate_by_seed_pt_profile
	Make profile of the fake rate versus seed transverse momentum Rename the quantities to names that display nicely by root latex translation.

	save_fake_rate_by_seed_tan_lambda_profile_groupbyCharge
	Charge dependent histograms Make profile of the fake rate versus seed tan(lambda)

	save_fake_rate_by_seed_pt_profile_groupbyCharge
	Charge dependent histograms Make profile of the fake rate versus seed transverse momentum.

	save_hit_counts_by_pt_profile
	Hit counts in each sub detector by the true pt value.

	save_hit_efficiency_by_pt_profile
	Hit efficiency in each sub detector by the true pt value.

	save_hit_purity_by_pt_profile
	Hit purity in each sub detector by the true pt value.

	save_hit_counts_by_tanlambda_profile
	Hit counts in each sub detector by the true tanlambda value.

	save_hit_efficiency_by_tanlambda_profile
	Hit efficiency in each sub detector by the true tanlambda value.

	save_hit_purity_by_tanlambda_profile
	Hit purity in each sub detector by the true tanlambda value.

	save_hit_counts_by_pt_profile_groupbyCharge
	Charge dependent histograms Hit counts in each sub detector by the true pt value.

	save_hit_counts_by_tanlambda_profile_groupbyCharge
	Charge dependent histograms Hit counts in each sub detector by the true tan lambda value.

	save_hit_efficiency_by_pt_profile_groupbyCharge
	Charge dependent histograms Hit efficiency in each sub detector by the true pt value.

	save_hit_efficiency_by_tanlambda_profile_groupbyCharge
	Charge dependent histograms Hit efficiency in each sub detector by the true tan lambda value.

	save_hit_efficiency
	Save simple FOM.

	save_pxd_hit_efficiency
	Save simple FOM.

	save_svd_hit_efficiency
	Save simple FOM.

	save_cdc_hit_efficiency
	Save simple FOM.

	save_hit_purity
	Save simple FOM.

	save_pxd_hit_purity
	Save simple FOM.

	save_svd_hit_purity
	Save simple FOM.

	save_cdc_hit_purity
	Save simple FOM.

	save_p_value_histogram
	Creates a distribution of p values from the Genfit track fit for match pr tracks.

	save_seed_omega_pull_analysis
	Pull of seed omega.

	save_seed_tan_lambda_pull_analysis
	Pull of seed tan(lambda)

	save_fitted_omega_pull_analysis
	Pull of fitted omega.

	save_fitted_tan_lambda_pull_analysis
	Pull of fitted tan(lambda)

	save_fitted_pt_pull_analysis
	Pull of fitted transverse momentum.

	save_fitted_x_pull_analysis
	Pull of fitted x coordinate grouped by true transverse momentum.

	save_fitted_y_pull_analysis
	Pull of fitted y coordinate grouped by true transverse momentum.

	save_fitted_z_pull_analysis
	Pull of fitted z coordinate grouped by true transverse momentum.

	save_resolutions_by_pt_profile
	Resolutions as a function of true p_t.

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

Detailed Description

Module to collect matching information about the found particles and to generate
   validation plots and figures of merit on the performance of track finding.

 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 25 of file pr_side_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 36 of file pr_side_module.py.

            expert_level=None):
        """Constructor"""
 
        output_file_name = output_file_name or name + 'TrackingValidation.root'
        super().__init__(foreach=reco_tracks_name,
                         name=name,
                         contact=contact,
                         output_file_name=output_file_name,
                         expert_level=expert_level)
 
        ## Name of the StoreArray of the tracks from pattern recognition
        self.reco_tracks_name = reco_tracks_name
 
        ## Name of the StoreArray of the ideal mc tracks
        self.mc_reco_tracks_name = mc_reco_tracks_name
 
        ## Reference to the track match lookup object reading the relation information constructed by the MCMatcherTracksModule
        self.track_match_look_up = None
 
        ## Cache for the hit content of the Monte Carlo tracks - updated each event
        self.mc_reco_tracks_det_hit_ids = []
 
        ## Cache for the MC hit lookup
        self.mc_hit_lookup = Belle2.TrackFindingCDC.CDCMCHitLookUp.getInstance()
 

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 68 of file pr_side_module.py.

    def initialize(self):
        """Receive signal at the start of event processing"""
        super().initialize()
        self.track_match_look_up = Belle2.TrackMatchLookUp(self.mc_reco_tracks_name,
                                                           self.reco_tracks_name)
 

◆ 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,
			reco_track )

Looks at the individual pattern recognition tracks and store information about them

Reimplemented from HarvestingModule.

Definition at line 92 of file pr_side_module.py.

    def peel(self, reco_track):
        """Looks at the individual pattern recognition tracks and store information about them"""
        track_match_look_up = self.track_match_look_up
 
        # Matching information
        mc_reco_track = track_match_look_up.getRelatedMCRecoTrack(reco_track)
        mc_particle = track_match_look_up.getRelatedMCParticle(reco_track)
        mc_particle_crops = peelers.peel_mc_particle(mc_particle)
 
        hit_content_crops = peelers.peel_reco_track_hit_content(reco_track)
 
        pr_to_mc_match_info_crops = self.peel_pr_to_mc_match_info(reco_track)
 
        # Peel function to get hit purity of subdetectors
        subdetector_hit_purity_crops = peelers.peel_subdetector_hit_purity(reco_track, mc_reco_track)
 
        # Information on TrackFinders
        trackfinder_crops = peelers.peel_trackfinder(reco_track)
 
        # Basic peel function to get Quality Indicators
        qualityindicator_crops = peelers.peel_quality_indicators(reco_track)
 
        # Get the fit results
        seed_fit_crops = peelers.peel_reco_track_seed(reco_track)
 
        fit_result = track_match_look_up.getRelatedTrackFitResult(reco_track)
        fit_crops = peelers.peel_track_fit_result(fit_result)
        fit_status_crops = peelers.peel_fit_status(reco_track)
 
        correct_rl_information = sum(peelers.is_correct_rl_information(cdc_hit, reco_track, self.mc_hit_lookup)
                                     for cdc_hit in getObjectList(reco_track.getCDCHitList()))
 
        crops = dict(
            correct_rl_information=correct_rl_information,
            **mc_particle_crops,
            **hit_content_crops,
            **pr_to_mc_match_info_crops,
            **subdetector_hit_purity_crops,  # Custom
            **trackfinder_crops,
            **qualityindicator_crops,
            **seed_fit_crops,
            **fit_crops,
            **fit_status_crops,
        )
 
        if self.expert_level >= self.default_expert_level:
 
            # Event Info
            event_meta_data = Belle2.PyStoreObj("EventMetaData")
            event_crops = peelers.peel_event_info(event_meta_data)
 
            # Store Array for easier joining
            store_array_crops = peelers.peel_store_array_info(reco_track, key="pr_{part_name}")
            mc_store_array_crops = peelers.peel_store_array_info(mc_reco_track, key="mc_{part_name}")
 
            # Information on PR reco track
            mc_efficiency_information = {
                "mc_hit_efficiency": track_match_look_up.getRelatedEfficiency(mc_reco_track) if mc_reco_track else float("nan"),
                **peelers.peel_subdetector_hit_efficiency(reco_track=reco_track, mc_reco_track=mc_reco_track,
                                                          key="mc_{part_name}")
            }
 
            crops.update(
                **event_crops,
                **store_array_crops,
                **mc_store_array_crops,
                **mc_efficiency_information
            )
 
        return crops
 

◆ peel_pr_to_mc_match_info()

peel_pr_to_mc_match_info	(		self,
			reco_track )

Extracts track-match information from the MCMatcherTracksModule results

Definition at line 163 of file pr_side_module.py.

    def peel_pr_to_mc_match_info(self, reco_track):
        """Extracts track-match information from the MCMatcherTracksModule results"""
        track_match_look_up = self.track_match_look_up
        is_matched = track_match_look_up.isAnyChargeMatchedPRRecoTrack(reco_track)
        is_matched_correct_charge = track_match_look_up.isCorrectChargeMatchedPRRecoTrack(reco_track)
        is_matched_wrong_charge = track_match_look_up.isWrongChargeMatchedPRRecoTrack(reco_track)
        is_clone = track_match_look_up.isAnyChargeClonePRRecoTrack(reco_track)
        is_clone_correct_charge = track_match_look_up.isCorrectChargeClonePRRecoTrack(reco_track)
        is_clone_wrong_charge = track_match_look_up.isWrongChargeClonePRRecoTrack(reco_track)
        is_background = track_match_look_up.isBackgroundPRRecoTrack(reco_track)
        is_ghost = track_match_look_up.isGhostPRRecoTrack(reco_track)
 
        reco_track_det_hit_ids = utilities.get_det_hit_ids(reco_track)
        n_intersecting_mc_tracks = 0
        for mc_reco_track_det_hit_ids in self.mc_reco_tracks_det_hit_ids:
            intersects = len(mc_reco_track_det_hit_ids & reco_track_det_hit_ids) > 0
            if intersects:
                n_intersecting_mc_tracks += 1
 
        mc_particle = track_match_look_up.getRelatedMCParticle(reco_track)
        mc_is_primary = False
        if mc_particle:
            mc_is_primary = bool(mc_particle.hasStatus(Belle2.MCParticle.c_PrimaryParticle))
 
        return dict(
            is_matched=is_matched,
            is_matchedPrimary=is_matched and mc_is_primary,
            is_matched_correct_charge=is_matched_correct_charge,
            is_matchedPrimary_correct_charge=is_matched_correct_charge and mc_is_primary,
            is_matched_wrong_charge=is_matched_wrong_charge,
            is_matchedPrimary_wrong_charge=is_matched_wrong_charge and mc_is_primary,
 
            is_clone=is_clone,
            is_clone_correct_charge=is_clone_correct_charge,
            is_clone_wrong_charge=is_clone_wrong_charge,
 
            is_background=is_background,
            is_ghost=is_ghost,
            is_clone_or_match=(is_matched or is_clone),
            is_fake=not (is_matched or is_clone),
            hit_purity=track_match_look_up.getRelatedPurity(reco_track),
            n_intersecting_mc_tracks=n_intersecting_mc_tracks,
        )
 

◆ pick()

pick	(		self,
			reco_track )

Method to filter the track candidates to reject part of them

Reimplemented from HarvestingModule.

Definition at line 88 of file pr_side_module.py.

    def pick(self, reco_track):
        """Method to filter the track candidates to reject part of them"""
        return True
 

◆ prepare()

prepare ( self )

Called once at the start of each event

Reimplemented from HarvestingModule.

Definition at line 74 of file pr_side_module.py.

    def prepare(self):
        """Called once at the start of each event"""
        super().prepare()
        mc_reco_tracks = Belle2.PyStoreArray(self.mc_reco_tracks_name)
        mc_reco_tracks_det_hit_ids = []
 
        for mc_reco_track in mc_reco_tracks:
            mc_reco_track_det_hit_ids = utilities.get_det_hit_ids(mc_reco_track)
            mc_reco_tracks_det_hit_ids.append(mc_reco_track_det_hit_ids)
 
        self.mc_reco_tracks_det_hit_ids = mc_reco_tracks_det_hit_ids
 
        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 )

inherited

Termination method of the module.

Finalize the collected crops.
Start the refinement.

Reimplemented in ClusterFilterValidationModule.

Definition at line 263 of file harvesting.py.

    def terminate(self):
        """Termination method of the module.
 
        Finalize the collected crops.
        Start the refinement.
        """
 
        self.stash.close()
        del self.stash
 
        try:
            self.refine(self.crops)
        except AttributeError:
            pass
 

Member Data Documentation

◆ 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()

Cache for the MC hit lookup.

Definition at line 66 of file pr_side_module.py.

◆ mc_reco_tracks_det_hit_ids

list mc_reco_tracks_det_hit_ids = []

Cache for the hit content of the Monte Carlo tracks - updated each event.

Definition at line 63 of file pr_side_module.py.

◆ mc_reco_tracks_name

mc_reco_tracks_name = mc_reco_tracks_name

Name of the StoreArray of the ideal mc tracks.

Definition at line 57 of file pr_side_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

Name of the StoreArray of the tracks from pattern recognition.

Definition at line 54 of file pr_side_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_cdc_hit_efficiency

save_cdc_hit_efficiency

static

Initial value:

=  refiners.save_fom(
        
    )

Save simple FOM.

Definition at line 674 of file pr_side_module.py.

◆ save_cdc_hit_purity

save_cdc_hit_purity

static

Initial value:

=  refiners.save_fom(
        
    )

Save simple FOM.

Definition at line 726 of file pr_side_module.py.

◆ save_clone_rate

save_clone_rate

static

Initial value:

=  refiners.save_fom(
        
    )

Save RecoTrack clone-rate information.

Definition at line 218 of file pr_side_module.py.

◆ save_clone_rate_by_seed_phi0_profile

save_clone_rate_by_seed_phi0_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Make profile of the clone rate versus seed phi0 Rename the quantities to names that display nicely by root latex translation.

Definition at line 251 of file pr_side_module.py.

◆ save_clone_rate_by_seed_pt_profile

save_clone_rate_by_seed_pt_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Make profile of the clone rate versus seed transverse momentum Rename the quantities to names that display nicely by root latex translation.

Definition at line 266 of file pr_side_module.py.

◆ save_clone_rate_by_seed_pt_profile_groupbyCharge

save_clone_rate_by_seed_pt_profile_groupbyCharge

static

Initial value:

=  refiners.save_profiles(
        
    )

Charge dependent histograms Make profile of the clone rate versus seed transverse momentum.

Definition at line 284 of file pr_side_module.py.

◆ save_clone_rate_by_seed_tan_lambda_profile

save_clone_rate_by_seed_tan_lambda_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Make profile of the clone rate versus seed tan(lambda) Rename the quantities to names that display nicely by root latex translation.

Definition at line 233 of file pr_side_module.py.

◆ save_clone_rate_by_seed_tan_lambda_profile_groupbyCharge

save_clone_rate_by_seed_tan_lambda_profile_groupbyCharge

static

Initial value:

=  refiners.save_profiles(
        
    )

Charge dependent histograms Make profile of the clone rate versus seed tan(lambda)

Definition at line 303 of file pr_side_module.py.

◆ save_fake_rate

save_fake_rate

static

Initial value:

=  refiners.save_fom(
        
    )

Save RecoTrack fake-rate information.

Definition at line 321 of file pr_side_module.py.

◆ save_fake_rate_by_seed_phi0_profile

save_fake_rate_by_seed_phi0_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Make profile of the fake rate versus seed phi0 Rename the quantities to names that display nicely by root latex translation.

Definition at line 336 of file pr_side_module.py.

◆ save_fake_rate_by_seed_pt_profile

save_fake_rate_by_seed_pt_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Make profile of the fake rate versus seed transverse momentum Rename the quantities to names that display nicely by root latex translation.

Definition at line 366 of file pr_side_module.py.

◆ save_fake_rate_by_seed_pt_profile_groupbyCharge

save_fake_rate_by_seed_pt_profile_groupbyCharge

static

Initial value:

=  refiners.save_profiles(
        
    )

Charge dependent histograms Make profile of the fake rate versus seed transverse momentum.

Definition at line 400 of file pr_side_module.py.

◆ save_fake_rate_by_seed_tan_lambda_profile

save_fake_rate_by_seed_tan_lambda_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Make profile of the fake rate versus seed tan(lambda) Rename the quantities to names that display nicely by root latex translation.

Definition at line 350 of file pr_side_module.py.

◆ save_fake_rate_by_seed_tan_lambda_profile_groupbyCharge

save_fake_rate_by_seed_tan_lambda_profile_groupbyCharge

static

Initial value:

=  refiners.save_profiles(
        
    )

Charge dependent histograms Make profile of the fake rate versus seed tan(lambda)

Definition at line 382 of file pr_side_module.py.

◆ save_fitted_omega_pull_analysis

save_fitted_omega_pull_analysis

static

Initial value:

=  refiners.save_pull_analysis(
        
    )

Pull of fitted omega.

Definition at line 776 of file pr_side_module.py.

◆ save_fitted_pt_pull_analysis

save_fitted_pt_pull_analysis

static

Initial value:

=  refiners.save_pull_analysis(
        
    )

Pull of fitted transverse momentum.

Definition at line 797 of file pr_side_module.py.

◆ save_fitted_tan_lambda_pull_analysis

save_fitted_tan_lambda_pull_analysis

static

Initial value:

=  refiners.save_pull_analysis(
        
    )

Pull of fitted tan(lambda)

Definition at line 787 of file pr_side_module.py.

◆ save_fitted_x_pull_analysis

save_fitted_x_pull_analysis

static

Initial value:

=  refiners.save_pull_analysis(
        
    )

Pull of fitted x coordinate grouped by true transverse momentum.

Definition at line 807 of file pr_side_module.py.

◆ save_fitted_y_pull_analysis

save_fitted_y_pull_analysis

static

Initial value:

=  refiners.save_pull_analysis(
        
    )

Pull of fitted y coordinate grouped by true transverse momentum.

Definition at line 818 of file pr_side_module.py.

◆ save_fitted_z_pull_analysis

save_fitted_z_pull_analysis

static

Initial value:

=  refiners.save_pull_analysis(
        
    )

Pull of fitted z coordinate grouped by true transverse momentum.

Definition at line 829 of file pr_side_module.py.

◆ save_hit_counts_by_pt_profile

save_hit_counts_by_pt_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Hit counts in each sub detector by the true pt value.

Definition at line 417 of file pr_side_module.py.

◆ save_hit_counts_by_pt_profile_groupbyCharge

save_hit_counts_by_pt_profile_groupbyCharge

static

Initial value:

=  refiners.save_profiles(
        
    )

Charge dependent histograms Hit counts in each sub detector by the true pt value.

Definition at line 544 of file pr_side_module.py.

◆ save_hit_counts_by_tanlambda_profile

save_hit_counts_by_tanlambda_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Hit counts in each sub detector by the true tanlambda value.

Definition at line 480 of file pr_side_module.py.

◆ save_hit_counts_by_tanlambda_profile_groupbyCharge

save_hit_counts_by_tanlambda_profile_groupbyCharge

static

Initial value:

=  refiners.save_profiles(
        
    )

Charge dependent histograms Hit counts in each sub detector by the true tan lambda value.

Definition at line 567 of file pr_side_module.py.

◆ save_hit_efficiency

save_hit_efficiency

static

Initial value:

=  refiners.save_fom(
        
    )

Save simple FOM.

Definition at line 635 of file pr_side_module.py.

◆ save_hit_efficiency_by_pt_profile

save_hit_efficiency_by_pt_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Hit efficiency in each sub detector by the true pt value.

Definition at line 438 of file pr_side_module.py.

◆ save_hit_efficiency_by_pt_profile_groupbyCharge

save_hit_efficiency_by_pt_profile_groupbyCharge

static

Initial value:

=  refiners.save_profiles(
        
    )

Charge dependent histograms Hit efficiency in each sub detector by the true pt value.

Definition at line 590 of file pr_side_module.py.

◆ save_hit_efficiency_by_tanlambda_profile

save_hit_efficiency_by_tanlambda_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Hit efficiency in each sub detector by the true tanlambda value.

Definition at line 501 of file pr_side_module.py.

◆ save_hit_efficiency_by_tanlambda_profile_groupbyCharge

save_hit_efficiency_by_tanlambda_profile_groupbyCharge

static

Initial value:

=  refiners.save_profiles(
        
    )

Charge dependent histograms Hit efficiency in each sub detector by the true tan lambda value.

Definition at line 613 of file pr_side_module.py.

◆ save_hit_purity

save_hit_purity

static

Initial value:

=  refiners.save_fom(
        
    )

Save simple FOM.

Definition at line 687 of file pr_side_module.py.

◆ save_hit_purity_by_pt_profile

save_hit_purity_by_pt_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Hit purity in each sub detector by the true pt value.

Definition at line 459 of file pr_side_module.py.

◆ save_hit_purity_by_tanlambda_profile

save_hit_purity_by_tanlambda_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Hit purity in each sub detector by the true tanlambda value.

Definition at line 522 of file pr_side_module.py.

◆ save_p_value_histogram

save_p_value_histogram

static

Initial value:

=  refiners.save_histograms(
        
    )

Creates a distribution of p values from the Genfit track fit for match pr tracks.

Definition at line 739 of file pr_side_module.py.

◆ save_pxd_hit_efficiency

save_pxd_hit_efficiency

static

Initial value:

=  refiners.save_fom(
        
    )

Save simple FOM.

Definition at line 648 of file pr_side_module.py.

◆ save_pxd_hit_purity

save_pxd_hit_purity

static

Initial value:

=  refiners.save_fom(
        
    )

Save simple FOM.

Definition at line 700 of file pr_side_module.py.

◆ save_resolutions_by_pt_profile

save_resolutions_by_pt_profile

static

Initial value:

=  refiners.save_profiles(
        
    )

Resolutions as a function of true p_t.

Definition at line 840 of file pr_side_module.py.

◆ save_seed_omega_pull_analysis

save_seed_omega_pull_analysis

static

Initial value:

=  refiners.save_pull_analysis(
        
    )

Pull of seed omega.

Definition at line 753 of file pr_side_module.py.

◆ save_seed_tan_lambda_pull_analysis

save_seed_tan_lambda_pull_analysis

static

Initial value:

=  refiners.save_pull_analysis(
        
    )

Pull of seed tan(lambda)

Definition at line 765 of file pr_side_module.py.

◆ save_svd_hit_efficiency

save_svd_hit_efficiency

static

Initial value:

=  refiners.save_fom(
        
    )

Save simple FOM.

Definition at line 661 of file pr_side_module.py.

◆ save_svd_hit_purity

save_svd_hit_purity

static

Initial value:

=  refiners.save_fom(
        
    )

Save simple FOM.

Definition at line 713 of file pr_side_module.py.

◆ save_tree

save_tree

static

Initial value:

=  refiners.save_tree(
        
    )

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

Definition at line 211 of file pr_side_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 = None

Reference to the track match lookup object reading the relation information constructed by the MCMatcherTracksModule.

Definition at line 60 of file pr_side_module.py.

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

tracking/scripts/tracking/harvesting_validation/pr_side_module.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()

◆ peel_pr_to_mc_match_info()

◆ pick()

◆ prepare()

◆ refine()

◆ terminate()

Member Data Documentation

◆ contact

◆ crops

◆ default_expert_level

◆ expert_level

◆ foreach

◆ mc_hit_lookup

◆ mc_reco_tracks_det_hit_ids

◆ mc_reco_tracks_name

◆ output_file_name

◆ raw_crops

◆ reco_tracks_name

◆ refiners

◆ save_cdc_hit_efficiency

◆ save_cdc_hit_purity

◆ save_clone_rate

◆ save_clone_rate_by_seed_phi0_profile

◆ save_clone_rate_by_seed_pt_profile

◆ save_clone_rate_by_seed_pt_profile_groupbyCharge

◆ save_clone_rate_by_seed_tan_lambda_profile

◆ save_clone_rate_by_seed_tan_lambda_profile_groupbyCharge

◆ save_fake_rate

◆ save_fake_rate_by_seed_phi0_profile

◆ save_fake_rate_by_seed_pt_profile

◆ save_fake_rate_by_seed_pt_profile_groupbyCharge

◆ save_fake_rate_by_seed_tan_lambda_profile

◆ save_fake_rate_by_seed_tan_lambda_profile_groupbyCharge

◆ save_fitted_omega_pull_analysis

◆ save_fitted_pt_pull_analysis

◆ save_fitted_tan_lambda_pull_analysis

◆ save_fitted_x_pull_analysis

◆ save_fitted_y_pull_analysis

◆ save_fitted_z_pull_analysis

◆ save_hit_counts_by_pt_profile

◆ save_hit_counts_by_pt_profile_groupbyCharge

◆ save_hit_counts_by_tanlambda_profile

◆ save_hit_counts_by_tanlambda_profile_groupbyCharge

◆ save_hit_efficiency

◆ save_hit_efficiency_by_pt_profile

◆ save_hit_efficiency_by_pt_profile_groupbyCharge

◆ save_hit_efficiency_by_tanlambda_profile

◆ save_hit_efficiency_by_tanlambda_profile_groupbyCharge

◆ save_hit_purity

◆ save_hit_purity_by_pt_profile

◆ save_hit_purity_by_tanlambda_profile

◆ save_p_value_histogram

◆ save_pxd_hit_efficiency

◆ save_pxd_hit_purity

◆ save_resolutions_by_pt_profile

◆ save_seed_omega_pull_analysis

◆ save_seed_tan_lambda_pull_analysis

◆ save_svd_hit_efficiency

◆ save_svd_hit_purity

◆ save_tree

◆ show_results

◆ stash

◆ title

◆ track_match_look_up

◆ init()