Inheritance diagram for ReadOrGenerateTrackedEventsRun:

Public Member Functions
def	create_argument_parser (self, **kwds)

def	create_path (self)

Static Public Attributes
str	description = "Apply tracking to presimulated events or events generated on the fly."
	Description of the run setup to be displayed on command line.

None	finder_module = None
	Name of the finder module to be used - can be everything that is accepted by tracking.run.utilities.extend_path.

dict	tracking_coverage
	States which detectors the finder module covers like as a dictionary like.

bool	fit_tracks = False
	By default, do not add the track fitting to the execution.

bool	mc_tracking = True
	By default, do MC track finding and track matching.

Detailed Description

 Apply tracking to presimulated events or events generated on the fly

Definition at line 25 of file tracked_event_generation.py.

Member Function Documentation

◆ create_argument_parser()

def create_argument_parser	(		self,
		**	kwds
	)

Convert command-line arguments to basf2 argument list

Reimplemented from ReadOrGenerateEventsRun.

Reimplemented in TrackingValidationRun, and CDCDisplayRun.

Definition at line 52 of file tracked_event_generation.py.

    def create_argument_parser(self, **kwds):
        """Convert command-line arguments to basf2 argument list"""
        argument_parser = super().create_argument_parser(**kwds)
 
        tracking_argument_group = argument_parser.add_argument_group("Tracking setup arguments")
 
        tracking_argument_group.add_argument(
            '-f',
            '--finder',
            choices=utilities.NonstrictChoices(finder_modules_by_short_name.keys()),
            default=self.finder_module,
            dest='finder_module',
            help='Name of the finder module to be evaluated.',)
 
        tracking_argument_group.add_argument(
            '--fit',
            action="store_true",
            default=self.fit_tracks,
            dest='fit_tracks',
            help='Apply the fitting to the found tracks'
        )
 
        return argument_parser
 

◆ create_path()

def create_path ( self )

Sets up a path that plays back pregenerated events or generates events
   based on the properties in the base class.

Reimplemented from ReadOrGenerateEventsRun.

Reimplemented in TrackingValidationRun, and CDCDisplayRun.

Definition at line 76 of file tracked_event_generation.py.

    def create_path(self):
        """Sets up a path that plays back pregenerated events or generates events
           based on the properties in the base class."""
        path = super().create_path()
 
        # setting up fitting is only necessary when testing
        # track finding comonenst ex-situ
        if self.fit_tracks:
            if 'SetupGenfitExtrapolation' not in path:
                # Prepare Genfit extrapolation
                path.add_module('SetupGenfitExtrapolation')
 
        if self.finder_module is not None:
            # Setup track finder
            utilities.extend_path(path,
                                  self.finder_module,
                                  finder_modules_by_short_name,
                                  allow_function_import=True)
 
            # determine which sub-detector hits will be used
            tracking_coverage = dict(self.tracking_coverage)
 
            matching_coverage = {key: value for key, value in tracking_coverage.items()
                                 if key in ('UsePXDHits', 'UseSVDHits', 'UseCDCHits', 'MinimalEfficiency', 'MinimalPurity')}
            # Removing minimal efficiency and purity as they are only parameters of the matching
            if "MinimalEfficiency" in tracking_coverage:
                tracking_coverage.pop("MinimalEfficiency")
            if "MinimalPurity" in tracking_coverage:
                tracking_coverage.pop("MinimalPurity")
 
            # Include the mc tracks if the monte carlo data is presentx
            if self.mc_tracking and 'MCRecoTracksMatcher' not in path:
                # Reference Monte Carlo tracks
                track_finder_mc_truth_module = basf2.register_module('TrackFinderMCTruthRecoTracks')
 
                # Track matcher
                mc_track_matcher_module = basf2.register_module('MCRecoTracksMatcher')
 
                path.add_module(IfMCParticlesPresentModule(track_finder_mc_truth_module))
                path.add_module(IfMCParticlesPresentModule(mc_track_matcher_module))
 
            # this ensures that the parameters are set in both cases (if the modules have been added or are already in the path)
            # only check for containment to also cope with the "IfMCParticlesPresentModule" cases correctly
            for module in path.modules():
                if 'MCRecoTracksMatcher' in module.name():
                    module.param({
                          'mcRecoTracksStoreArrayName': 'MCRecoTracks',
                          'MinimalPurity': 0.66,
                          'prRecoTracksStoreArrayName': "RecoTracks",
                          **matching_coverage
                        })
                if 'TrackFinderMCTruthRecoTracks' in module.name():
                    module.param({
                          'RecoTracksStoreArrayName': 'MCRecoTracks',
                          **tracking_coverage
                        })
 
        if self.fit_tracks:
            # Fit tracks
            gen_fitter_module = basf2.register_module('DAFRecoFitter')
            gen_fitter_module.param({'pdgCodesToUseForFitting': [211]})
            path.add_module(gen_fitter_module)
            trackbuilder = basf2.register_module('TrackCreator', pdgCodes=[211])
            path.add_module(trackbuilder)
 
        return path
 
 

Member Data Documentation

◆ description

str description = "Apply tracking to presimulated events or events generated on the fly."

static

Description of the run setup to be displayed on command line.

Definition at line 29 of file tracked_event_generation.py.

◆ finder_module

None finder_module = None

static

Name of the finder module to be used - can be everything that is accepted by tracking.run.utilities.extend_path.

Reimplemented in CDCLegendre, CDCLegendre, CombinedSVDTrackingValidation, CombinedSVDTrackingValidationBkg, fullTrackingValidation_plusECL, SVDHoughTrackingValidation, SVDHoughTrackingValidationBkg, toCDCCKFValidationBkg, toCDCfromEclCKF, toCDCfromEclCKF, Full, StandardReconstructionEventsRun, CDCAutomaton, CDCAutomaton, CDCCombined, CDCCombined, CDCCR, CDCFull, CDCFull, CosmicsAxialHough, and CosmicsHough.

Definition at line 32 of file tracked_event_generation.py.

◆ fit_tracks

bool fit_tracks = False

static

By default, do not add the track fitting to the execution.

Definition at line 47 of file tracked_event_generation.py.

◆ mc_tracking

bool mc_tracking = True

static

By default, do MC track finding and track matching.

Definition at line 50 of file tracked_event_generation.py.

◆ tracking_coverage

dict tracking_coverage

static

Initial value:

=  {
        'UsePXDHits': True,
        'UseSVDHits': True,
        'UseCDCHits': True,
        'UseOnlyAxialCDCHits': False,
        'UseOnlyBeforeTOP': True,
        'UseReassignedHits': True,
        'UseNLoops': 1,
        'WhichParticles': [],
    }

States which detectors the finder module covers like as a dictionary like.

Definition at line 35 of file tracked_event_generation.py.

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

tracking/scripts/tracking/run/tracked_event_generation.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ create_argument_parser()

◆ create_path()

Member Data Documentation

◆ description

◆ finder_module

◆ fit_tracks

◆ mc_tracking

◆ tracking_coverage