EventwiseTrackingValidationModule Class Reference

Inheritance diagram for EventwiseTrackingValidationModule:

Collaboration diagram for EventwiseTrackingValidationModule:

Public Member Functions
def	__init__ (self, name, contact, output_file_name=None, reco_tracks_name='RecoTracks', mc_reco_tracks_name='MCRecoTracks', expert_level=None)
def	initialize (self)
def	pick (self, event_meta_data=None)
def	peel (self, event_meta_data=None)

Public Attributes
	reco_tracks_name
	cached value of the RecoTracks collection name
	mc_reco_tracks_name
	cached value of the MCRecoTracks collection name
	cdc_hits_name
	cached value of the CDCHits collection name
	track_match_look_up
	Reference to the track-match object that examines relation information from MCMatcherTracksModule.

Static Public Attributes
int	default_expert_level = 10
	the threshold value for the expert level
refiners	save_tree
	Save a tree of all collected variables in a sub folder.
refiners	save_clone_rate
	Save selected hit counters.

Detailed Description

Module to perform event-by-event tracking validation.

 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 21 of file eventwise_module.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			name,
			contact,
			output_file_name = None,
			reco_tracks_name = 'RecoTracks',
			mc_reco_tracks_name = 'MCRecoTracks',
			expert_level = None
	)

Constructor

Definition at line 32 of file eventwise_module.py.

                 expert_level=None):
        """Constructor"""
 
        output_file_name = output_file_name or name + 'TrackingValidation.root'
 
        super().__init__(foreach="EventMetaData",  # Dummy for on element per event
                         name=name,
                         output_file_name=output_file_name,
                         contact=contact,
                         expert_level=expert_level)
 
        
        self.reco_tracks_name = reco_tracks_name
        
        self.mc_reco_tracks_name = mc_reco_tracks_name
        
        self.cdc_hits_name = "CDCHits"
 

Member Function Documentation

initialize()

def initialize

(

self

)

Initialization signal at the start of the event processing

Definition at line 56 of file eventwise_module.py.

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

peel()

def peel	(		self,
			event_meta_data = None
	)

Peel information from the event

Definition at line 67 of file eventwise_module.py.

    def peel(self, event_meta_data=None):
        """Peel information from the event"""
        # Note event_meta_data is just used as a dummy.
 
        track_match_look_up = self.track_match_look_up
        reco_tracks = Belle2.PyStoreArray(self.reco_tracks_name)
        mc_reco_tracks = Belle2.PyStoreArray(self.mc_reco_tracks_name)
        cdc_hits = Belle2.PyStoreArray(self.cdc_hits_name)
        mc_particles = Belle2.PyStoreArray("MCParticles")
 
        # General object count in the event.
        if mc_particles:
            n_mc_particles = mc_particles.getEntries()
        else:
            n_mc_particles = -1
 
        if mc_reco_tracks:
            n_mc_reco_tracks = mc_reco_tracks.getEntries()
        else:
            n_mc_reco_tracks = -1
 
        n_reco_tracks = reco_tracks.getEntries()
 
        # Aggregate information about Monte Carlo tracks
        all_mc_tracks_det_hit_ids = set()
        n_matched_mc_reco_tracks = 0
        n_matched_correct_charge_mc_reco_tracks = 0
        n_matched_wrong_charge_mc_reco_tracks = 0
        n_merged_mc_reco_tracks = 0
        n_merged_correct_charge_mc_reco_tracks = 0
        n_merged_wrong_charge_mc_reco_tracks = 0
        n_missing_mc_reco_tracks = 0
        for mc_reco_track in mc_reco_tracks:
            mc_reco_track_det_hit_ids = utilities.get_det_hit_ids(mc_reco_track)
            all_mc_tracks_det_hit_ids.update(mc_reco_track_det_hit_ids)
 
            is_matched = track_match_look_up.isAnyChargeMatchedMCRecoTrack(mc_reco_track)
            is_matched_correct_charge = track_match_look_up.isCorrectChargeMatchedMCRecoTrack(mc_reco_track)
            is_matched_wrong_charge = track_match_look_up.isWrongChargeMatchedMCRecoTrack(mc_reco_track)
            is_merged = track_match_look_up.isAnyChargeMergedMCRecoTrack(mc_reco_track)
            is_merged_correct_charge = track_match_look_up.isCorrectChargeMergedMCRecoTrack(mc_reco_track)
            is_merged_wrong_charge = track_match_look_up.isWrongChargeMergedMCRecoTrack(mc_reco_track)
            is_missing = track_match_look_up.isMissingMCRecoTrack(mc_reco_track)
 
            if is_matched:
                n_matched_mc_reco_tracks += 1
                if is_matched_correct_charge:
                    n_matched_correct_charge_mc_reco_tracks += 1
                elif is_matched_wrong_charge:
                    n_matched_wrong_charge_mc_reco_tracks += 1
            elif is_merged:
                n_merged_mc_reco_tracks += 1
                if is_merged_correct_charge:
                    n_merged_correct_charge_mc_reco_tracks += 1
                elif is_merged_wrong_charge:
                    n_merged_wrong_charge_mc_reco_tracks += 1
            elif is_missing:
                n_missing_mc_reco_tracks += 1
 
        # Aggregate information about pattern recognition tracks
        n_matched_reco_tracks = 0
        n_matched_correct_charge_reco_tracks = 0
        n_matched_wrong_charge_reco_tracks = 0
        n_clone_reco_tracks = 0
        n_clone_correct_charge_reco_tracks = 0
        n_clone_wrong_charge_reco_tracks = 0
        n_background_reco_tracks = 0
        n_ghost_reco_tracks = 0
 
        all_tracks_det_hit_ids = set()
        n_matched_hits = 0
        for reco_track in reco_tracks:
            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)
 
            if is_matched:
                n_matched_reco_tracks += 1
                if is_matched_correct_charge:
                    n_matched_correct_charge_reco_tracks += 1
                elif is_matched_wrong_charge:
                    n_matched_wrong_charge_reco_tracks += 1
            elif is_clone:
                n_clone_reco_tracks += 1
                if is_clone_correct_charge:
                    n_clone_correct_charge_reco_tracks += 1
                elif is_clone_wrong_charge:
                    n_clone_wrong_charge_reco_tracks += 1
            elif is_background:
                n_background_reco_tracks += 1
            elif is_ghost:
                n_ghost_reco_tracks += 1
 
            reco_track_det_hit_ids = utilities.get_det_hit_ids(reco_track)
 
            all_tracks_det_hit_ids.update(reco_track_det_hit_ids)
            if is_matched or is_clone:
                mc_reco_track = self.track_match_look_up.getRelatedMCRecoTrack(reco_track)
 
                mc_reco_track_det_hit_ids = utilities.get_det_hit_ids(mc_reco_track)
                n_matched_hits += len(reco_track_det_hit_ids & mc_reco_track_det_hit_ids)
 
        return dict(
            n_mc_particles=n_mc_particles,
            n_mc_reco_tracks=n_mc_reco_tracks,
            n_reco_tracks=n_reco_tracks,
 
            n_matched_mc_reco_tracks=n_matched_mc_reco_tracks,
            n_matched_correct_charge_mc_reco_tracks=n_matched_correct_charge_mc_reco_tracks,
            n_matched_wrong_charge_mc_reco_tracks=n_matched_wrong_charge_mc_reco_tracks,
 
            n_merged_mc_reco_tracks=n_merged_mc_reco_tracks,
            n_merged_correct_charge_mc_reco_tracks=n_merged_correct_charge_mc_reco_tracks,
            n_merged_wrong_charge_mc_reco_tracks=n_merged_wrong_charge_mc_reco_tracks,
 
            n_missing_mc_reco_tracks=n_missing_mc_reco_tracks,
 
 
            n_matched_reco_tracks=n_matched_reco_tracks,
            n_matched_correct_charge_reco_tracks=n_matched_correct_charge_reco_tracks,
            n_matched_wrong_charge_reco_tracks=n_matched_wrong_charge_reco_tracks,
            n_clone_reco_tracks=n_clone_reco_tracks,
            n_clone_correct_charge_reco_tracks=n_clone_correct_charge_reco_tracks,
            n_clone_wrong_charge_reco_tracks=n_clone_wrong_charge_reco_tracks,
 
            n_background_reco_tracks=n_background_reco_tracks,
            n_ghost_reco_tracks=n_ghost_reco_tracks,
 
            n_cdc_hits=cdc_hits.getEntries(),
            n_all_mc_track_hits=len(all_mc_tracks_det_hit_ids),
            n_all_track_hits=len(all_tracks_det_hit_ids),
            n_found_hits=len(all_mc_tracks_det_hit_ids & all_tracks_det_hit_ids),
            n_matched_hits=n_matched_hits
        )
 

pick()

def pick	(		self,
			event_meta_data = None
	)

Always pick

Definition at line 63 of file eventwise_module.py.

    def pick(self, event_meta_data=None):
        """Always pick"""
        return True
 

Member Data Documentation

cdc_hits_name

cdc_hits_name

cached value of the CDCHits collection name

Definition at line 54 of file eventwise_module.py.

default_expert_level

int default_expert_level = 10

static

the threshold value for the expert level

Definition at line 30 of file eventwise_module.py.

mc_reco_tracks_name

mc_reco_tracks_name

cached value of the MCRecoTracks collection name

Definition at line 52 of file eventwise_module.py.

reco_tracks_name

reco_tracks_name

cached value of the RecoTracks collection name

Definition at line 50 of file eventwise_module.py.

save_clone_rate

refiners save_clone_rate

static

Initial value:

=  refiners.save_fom(
        # using cond to suppress false doxygen warnings
        
 
 
 
 
 
 
 
 
 
 
 
 
 
 
    )

Save selected hit counters.

Definition at line 221 of file eventwise_module.py.

save_tree

refiners save_tree

static

Initial value:

=  refiners.save_tree(
        # using cond to suppress false doxygen warnings
        
 
 
 
 
    )

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

Definition at line 211 of file eventwise_module.py.

track_match_look_up

track_match_look_up

Reference to the track-match object that examines relation information from MCMatcherTracksModule.

Definition at line 60 of file eventwise_module.py.

---

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

• tracking/scripts/tracking/harvesting_validation/eventwise_module.py