run.py

#!/usr/bin/env python3
 
 
 
 
import logging
import argparse
 
from tracking.run.tracked_event_generation import ReadOrGenerateTrackedEventsRun
from tracking.run.mixins import BrowseTFileOnTerminateRunMixin
from tracking.validation.hit_module import ExpertTrackingValidationModule
from tracking.harvesting_validation.combined_module import CombinedTrackingValidationModule
 
 
TRACKING_MAILING_LIST = 'software-tracking@belle2.org'
 
 
class TrackingValidationRun(BrowseTFileOnTerminateRunMixin, ReadOrGenerateTrackedEventsRun):
    """Run setup to compose a path to validate the the tracking procedures from pre-simulated events
    or from events simulated on the fly. Considering parameters from the commandline."""
 
    
    contact = TRACKING_MAILING_LIST
 
    
    output_file_name = 'TrackingValidation.root'  # Also specification for BrowseTFileOnTerminateRunMixin
 
    
    root_output_file = None
 
    
    pulls = True
 
    
    resolution = False
 
    
    use_expert_folder = True
 
    
    exclude_profile_mc_parameter = []
 
    
    exclude_profile_pr_parameter = []
 
    
    use_fit_information = False
 
    
    extended = False
 
    
    saveFullTrees = False
 
    
    non_expert_parameters = ['p_{t}']
 
    def preparePathValidation(self, path):
        """The default way to add the validation module to the path.
 
        Derived classes can overload this method modify the validation module
        or add more than one validation steps.
        """
 
        if self.extended:
            expert_level = None
            if self.saveFullTrees:
                expert_level = 200
 
            trackingValidationModule = CombinedTrackingValidationModule(
                name=self.name,
                contact=self.contact,
                output_file_name=self.output_file_nameoutput_file_name,
                expert_level=expert_level
            )
        else:
            # Validation module generating plots
            trackingValidationModule = ExpertTrackingValidationModule(
                self.name,
                contact=self.contact,
                fit=self.use_fit_information or self.fit_tracks,
                pulls=self.pulls,
                resolution=self.resolution,
                output_file_name=self.output_file_nameoutput_file_name,
                use_expert_folder=self.use_expert_folder,
                exclude_profile_mc_parameter=self.exclude_profile_mc_parameter,
                exclude_profile_pr_parameter=self.exclude_profile_pr_parameter
            )
            trackingValidationModule.trackCandidatesColumnName = "RecoTracks"
 
            # tell the module which are the shifter (aka non-experts) plots
            trackingValidationModule.non_expert_parameters = self.non_expert_parameters
 
        path.add_module(trackingValidationModule)
 
    def create_argument_parser(self, **kwds):
        """Create command line argument parser"""
        argument_parser = super().create_argument_parser(**kwds)
 
        # Left over from earlier parameter settings. Overwrites the more fundamental simulation_only parameter
        argument_parser.add_argument(
            '-o',
            '--output',
            dest='simulation_output',
            default=argparse.SUPPRESS,
            help='Output file to which the simulated events shall be written.'
        )
 
        argument_parser.add_argument(
            '-e',
            '--extended',
            dest='extended',
            action='store_true',
            default=argparse.SUPPRESS,
            help='Use the extended validation with more plots and whistles'
        )
 
        return argument_parser
 
    def create_path(self):
        """Create path from parameters"""
        # Sets up a path that plays back pregenerated events or generates events
        # based on the properties in the base class.
        path = super().create_path()
 
        # add the validation module to the path
        self.preparePathValidation(path)
 
        if self.root_output_file:
            path.add_module("RootOutput", outputFileName=self.root_output_file)
 
        return path
 
 
def main():
    trackingValiddationRun = TrackingValidationRun()
    trackingValiddationRun.configure_and_execute_from_commandline()
 
 
if __name__ == '__main__':
    logging.basicConfig(level=logging.INFO)
    main()