TrackingValidationRun Class Reference

Inheritance diagram for TrackingValidationRun:

Public Member Functions
def	preparePathValidation (self, path)
def	create_argument_parser (self, **kwds)
def	create_path (self)

Static Public Attributes
TRACKING_MAILING_LIST	contact = TRACKING_MAILING_LIST
	Default contact email address for the validation results.
str	output_file_name = 'TrackingValidation.root'
	Name of the output file for the validation results.
None	root_output_file = None
	Optional file name as a destination of all event data which is discarded otherwise.
bool	pulls = True
	Include the pull plots of the fit parameters in the validation.
bool	resolution = False
	Include the residual plots of the fit parameters in the validation.
bool	use_expert_folder = True
	Use the "expert" folder in the validation file as the destination of the pull and residual plots.
list	exclude_profile_mc_parameter = []
	Exclude some of the perigee parameters from the mc side plots.
list	exclude_profile_pr_parameter = []
	Exclude some of the perigee parameters from the pr side plots.
bool	use_fit_information = False
	Do not fit the tracks but access the fit information for pulls etc.
bool	extended = False
	Switch to use the extended harvesting validation instead.
bool	saveFullTrees = False
	Only works in extended mode.
list	non_expert_parameters = ['p_{t}']
	List of parameters which should be used as shifter plots (all plots with these x-labels)

Detailed Description

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.

Definition at line 24 of file run.py.

Member Function Documentation

create_argument_parser()

def create_argument_parser	(		self,
		**	kwds
	)

Create command line argument parser

Reimplemented from BrowseTFileOnTerminateRunMixin.

Definition at line 102 of file run.py.

    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
 

create_path()

def create_path

(

self

)

Create path from parameters

Reimplemented from ReadOrGenerateTrackedEventsRun.

Definition at line 126 of file run.py.

    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
 
 

preparePathValidation()

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.

Definition at line 64 of file run.py.

    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_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_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)
 

Member Data Documentation

contact

TRACKING_MAILING_LIST contact = TRACKING_MAILING_LIST

static

Default contact email address for the validation results.

Definition at line 29 of file run.py.

exclude_profile_mc_parameter

list exclude_profile_mc_parameter = []

static

Exclude some of the perigee parameters from the mc side plots.

Definition at line 47 of file run.py.

exclude_profile_pr_parameter

list exclude_profile_pr_parameter = []

static

Exclude some of the perigee parameters from the pr side plots.

Definition at line 50 of file run.py.

extended

bool extended = False

static

Switch to use the extended harvesting validation instead.

Definition at line 56 of file run.py.

non_expert_parameters

list non_expert_parameters = ['p_{t}']

static

List of parameters which should be used as shifter plots (all plots with these x-labels)

Definition at line 62 of file run.py.

output_file_name

str output_file_name = 'TrackingValidation.root'

static

Name of the output file for the validation results.

Definition at line 32 of file run.py.

pulls

bool pulls = True

static

Include the pull plots of the fit parameters in the validation.

Definition at line 38 of file run.py.

resolution

bool resolution = False

static

Include the residual plots of the fit parameters in the validation.

Definition at line 41 of file run.py.

root_output_file

None root_output_file = None

static

Optional file name as a destination of all event data which is discarded otherwise.

Definition at line 35 of file run.py.

saveFullTrees

bool saveFullTrees = False

static

Only works in extended mode.

Definition at line 59 of file run.py.

use_expert_folder

bool use_expert_folder = True

static

Use the "expert" folder in the validation file as the destination of the pull and residual plots.

Definition at line 44 of file run.py.

use_fit_information

bool use_fit_information = False

static

Do not fit the tracks but access the fit information for pulls etc.

Definition at line 53 of file run.py.

---

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

• tracking/scripts/tracking/validation/run.py