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
	save_tree
	Save a tree of all collected variables in a sub folder. More...
	save_clone_rate
	Save selected hit counters. More...

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

    def __init__(self,
                 name,
                 contact,
                 output_file_name=None,
                 reco_tracks_name='RecoTracks',
                 mc_reco_tracks_name='MCRecoTracks',
                 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 51 of file eventwise_module.py.

peel()

def peel	(		self,
			event_meta_data = None
	)

Peel information from the event

Definition at line 62 of file eventwise_module.py.

pick()

def pick	(		self,
			event_meta_data = None
	)

Always pick

Definition at line 58 of file eventwise_module.py.

Member Data Documentation

save_clone_rate

save_clone_rate

static

Initial value:

=  refiners.save_fom(
        name="{module.id}_hit_figures_of_merit",
        title="Hit sums in {module.title}",
        description="",  # to be given
        select=[
            "n_cdc_hits",
            "n_all_mc_track_hits",
            "n_all_track_hits",
            "n_found_hits",
            "n_matched_hits",
        ],
 
        aggregation=np.sum,
        key="{part_name}",
    )

Save selected hit counters.

Definition at line 167 of file eventwise_module.py.

save_tree

save_tree

static

Initial value:

=  refiners.save_tree(folder_name="event_tree",
                                   name="event_tree",
                                   above_expert_level=default_expert_level)

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

Definition at line 162 of file eventwise_module.py.

---

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

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