Belle II Software  release-08-01-10
TrackingValidationModule Class Reference
Inheritance diagram for TrackingValidationModule:
Collaboration diagram for TrackingValidationModule:

Public Member Functions

def __init__ (self, name, contact, fit=False, pulls=False, resolution=False, output_file_name=None, track_filter_object=AlwaysPassFilter(), plot_name_postfix='', plot_title_postfix='', exclude_profile_mc_parameter='', exclude_profile_pr_parameter='', use_expert_folder=True, trackCandidatesColumnName="RecoTracks", mcTrackCandidatesColumName="MCRecoTracks", non_expert_parameters=['p_{t}'])
 
def initialize (self)
 
def event (self)
 
def examine_pr_tracks (self)
 
def examine_mc_tracks (self)
 
def terminate (self)
 
def profiles_by_mc_parameters (self, xs, quantity_name, unit=None, parameter_names=['d_0', 'p_t', 'tan_lambda', 'multiplicity', 'phi', 'ndf',], make_hist=True, weights=None, is_asymmetry=False)
 
def profiles_by_pr_parameters (self, xs, quantity_name, unit=None, parameter_names=['Seed_p_t', 'Seed tan #lambda', 'Seed #phi'], make_hist=True)
 
def profiles_by_parameters_base (self, xs, quantity_name, parameter_names, profile_parameters, unit, make_hist, weights=None, is_asymmetry=False)
 

Public Attributes

 validation_name
 cached value of the tracking-validation name
 
 contact
 cached value of the contact person name
 
 fit
 cached value of the track fit
 
 pulls
 cached values of the track-fit pulls
 
 resolution
 cached value of the resolution
 
 output_file_name
 cached value of the output ROOT TFile
 
 track_filter_object
 cached value of the track-filter object
 
 plot_name_postfix
 cached value of the suffix appended to the plot names
 
 plot_title_postfix
 cached value of the suffix appended to the plot titles
 
 exclude_profile_pr_parameter
 cached list of perigee parameters excluded from PR side plots
 
 exclude_profile_mc_parameter
 cached list of perigee parameters excluded from MC side plots
 
 use_expert_folder
 cached flag to use the "expert" folder for the pull and residual plots
 
 trackCandidatesColumnName
 cached name of the RecoTracks StoreArray
 
 mcTrackCandidatesColumnName
 cached name of the MCRecoTracks StoreArray
 
 non_expert_parameters
 list of parameters that determines which plots (all with corresponding x-axis) are marked as shifter plots
 
 resolution_pt_binning
 default binning used for resolution plots over pt
 
 referenceFileName
 If this variable is set the code will open the file with same name as the file created here and will read the binning from the TH1/TProfile with same name as the one created here. More...
 
 trackMatchLookUp
 Track-match object that examines relation information from MCMatcherTracksModule.
 
 pr_clones_and_matches
 Use deques in favour of lists to prevent repeated memory allocation of cost O(n) More...
 
 pr_matches
 list of PR-track matches
 
 pr_fakes
 list of PR-track fakes
 
 pr_seed_pt
 list of PR-track seed pt values
 
 pr_seed_tan_lambdas
 list of PR-track seed tan(lambda) values
 
 pr_seed_phi
 list of PR-track seed phi values
 
 pr_omega_truths
 list of PR-track seed omega-truth values
 
 pr_omega_estimates
 list of PR-track seed omega-estimate values
 
 pr_omega_variances
 list of PR-track seed omega-variance values
 
 pr_tan_lambda_truths
 list of PR-track seed tan(lambda)-truth values
 
 pr_tan_lambda_estimates
 list of PR-track seed tan(lambda)-estimate values
 
 pr_tan_lambda_variances
 list of PR-track seed tan(lambda)-variance values
 
 pr_d0_truths
 list of PR-track seed d0-truth values
 
 pr_d0_estimates
 list of PR-track seed d0-estimate values
 
 pr_d0_variances
 list of PR-track seed d0-variance values
 
 pr_z0_truths
 list of PR-track seed z0-truth values
 
 pr_z0_estimates
 list of PR-track seed z0-estimate values
 
 pr_pt_truths
 list of PR-track seed pt-truth values
 
 pr_pt_estimates
 list of PR-track seed pt-estimate values
 
 pr_bining_pt
 list of PR-track binning values
 
 mc_matches
 list of MC-track matches
 
 mc_charge_matches
 list of MC-track matches, including matched charge
 
 mc_charge_asymmetry
 list of MC-track matches charge asymmetry
 
 mc_charge_asymmetry_weights
 list of MC-track matches charge asymmetry weights
 
 mc_primaries
 list of MC-track primaries
 
 mc_d0s
 list of MC-track d0 values
 
 mc_tan_lambdas
 list of MC-track tan(lambda) values
 
 mc_phi
 direction of the track in phi
 
 mc_pts
 list of MC-track pt values
 
 mc_hit_efficiencies
 list of MC-track hit efficiencies
 
 mc_multiplicities
 list of MC-track multiplicities
 
 mc_ndf
 list of MC-track number of degrees of freedom
 

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.

Definition at line 103 of file module.py.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  name,
  contact,
  fit = False,
  pulls = False,
  resolution = False,
  output_file_name = None,
  track_filter_object = AlwaysPassFilter(),
  plot_name_postfix = '',
  plot_title_postfix = '',
  exclude_profile_mc_parameter = '',
  exclude_profile_pr_parameter = '',
  use_expert_folder = True,
  trackCandidatesColumnName = "RecoTracks",
  mcTrackCandidatesColumName = "MCRecoTracks",
  non_expert_parameters = ['p_{t}'] 
)
Constructor

Definition at line 108 of file module.py.

Member Function Documentation

◆ event()

def event (   self)
Event method

Reimplemented in ExpertTrackingValidationModule.

Definition at line 259 of file module.py.

◆ examine_mc_tracks()

def examine_mc_tracks (   self)
Looks at the individual Monte Carlo tracks and store information about them

Definition at line 382 of file module.py.

◆ examine_pr_tracks()

def examine_pr_tracks (   self)
Looks at the individual pattern reconstructed tracks and store information about them

Definition at line 265 of file module.py.

◆ initialize()

def initialize (   self)
Receive signal at the start of event processing

Reimplemented in ExpertTrackingValidationModule.

Definition at line 178 of file module.py.

◆ profiles_by_mc_parameters()

def profiles_by_mc_parameters (   self,
  xs,
  quantity_name,
  unit = None,
  parameter_names = [             'd_0',             'p_t',             'tan_lambda',             'multiplicity',             'phi',             'ndf',         ],
  make_hist = True,
  weights = None,
  is_asymmetry = False 
)
Create profile histograms by MC-track parameters

Definition at line 710 of file module.py.

◆ profiles_by_parameters_base()

def profiles_by_parameters_base (   self,
  xs,
  quantity_name,
  parameter_names,
  profile_parameters,
  unit,
  make_hist,
  weights = None,
  is_asymmetry = False 
)
Create profile histograms for generic parameters

Definition at line 782 of file module.py.

◆ profiles_by_pr_parameters()

def profiles_by_pr_parameters (   self,
  xs,
  quantity_name,
  unit = None,
  parameter_names = ['Seed_p_t', 'Seed tan #lambda', 'Seed #phi'],
  make_hist = True 
)
Create profile histograms by PR-track parameters

Definition at line 754 of file module.py.

◆ terminate()

def terminate (   self)
Receive signal at the end of event processing

Reimplemented in ExpertTrackingValidationModule.

Definition at line 460 of file module.py.

Member Data Documentation

◆ pr_clones_and_matches

pr_clones_and_matches

Use deques in favour of lists to prevent repeated memory allocation of cost O(n)

list of PR-track clones and matches

Definition at line 187 of file module.py.

◆ referenceFileName

referenceFileName

If this variable is set the code will open the file with same name as the file created here and will read the binning from the TH1/TProfile with same name as the one created here.

If you do not want this feature either remove the corresponding root files from the validation directory (this will trigger the default behaviour) or set the environmental variable DO_NOT_READ_BINNING

Definition at line 169 of file module.py.


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