Inheritance diagram for ReadOrGenerateTrackedEventsRun:

Public Member Functions
	create_argument_parser (self, **kwds)

	create_path (self)

	configure (self, arguments)

	execute (self)

	name (self)

	configure_and_execute_from_commandline (self)

	run (self, path)

	configure_from_commandline (self)

	adjust_path (self, path)

Static Public Attributes
	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.

	generator_module = None
	By default, do not generate events.

str	detector_setup = "Default"
	By default, use the default detector setup.

list	bkg_files = []
	By default, no background overlay.

	components = None
	By default, do specific components.

bool	disable_deltas = False
	By default, do not disable delta-ray generation.

	simulation_output = None
	By default, do no store the simulation output.

bool	allow_input = True
	By default, this basf2 job can read events from an input ROOT TFile.

int	n_events = 10000
	By default, process 10000 events.

	root_input_file = None
	By default, there is no input ROOT TFile.

	random_seed = None
	By default, the random-number seed is unassigned.

int	n_processes = 0
	By default, no parallel processing.

int	n_events_to_skip = 0
	By default, do not skip any events at the start of the input ROOT TFile.

str	description = "Empty execution of basf2"
	Description of the run setup to be displayed on command line.

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

◆ adjust_path()

adjust_path	(		self,
			path )

inherited


Hook that gives the opportunity to check the path for consistency before processing it

Reimplemented in HarvestingRunMixin, VXDTF2TrackingValidation, and VXDTF2TrackingValidationBkg.

Definition at line 94 of file minimal.py.

    def adjust_path(self, path):
        """Hook that gives the opportunity to check the path for consistency before processing it"""
 
# Minimal run stub defining some general parameters

◆ configure()

configure	(		self,
			arguments )

inherited


Configure for basf2 job; disable ROOT input if simulating events

Reimplemented from EmptyRun.

Reimplemented in CDCDisplayRun.

Definition at line 122 of file event_generation.py.

    def configure(self, arguments):
        """Configure for basf2 job; disable ROOT input if simulating events"""
        super().configure(arguments)
        if self.simulation_output:
            get_logger().info("Requested to simulation run. Deactivate input file")
            
            self.root_input_file = None
 

◆ configure_and_execute_from_commandline()

configure_and_execute_from_commandline ( self )

inherited


Configure basf2 job script from command-line arguments then run it

Definition at line 45 of file minimal.py.

    def configure_and_execute_from_commandline(self):
        """Configure basf2 job script from command-line arguments then run it"""
        self.configure_from_commandline()
        self.execute()
 

◆ configure_from_commandline()

configure_from_commandline ( self )

inherited


Convert the command-line arguments to a basf2 job script

Definition at line 67 of file minimal.py.

    def configure_from_commandline(self):
        """Convert the command-line arguments to a basf2 job script"""
        argument_parser = self.create_argument_parser()
        arguments = argument_parser.parse_args()
        self.configure(arguments)
 

◆ create_argument_parser()

create_argument_parser	(		self,
		**	kwds )


Convert command-line arguments to basf2 argument list

Reimplemented from ReadOrGenerateEventsRun.

Reimplemented in CDCDisplayRun, and TrackingValidationRun.

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

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 CDCDisplayRun, and TrackingValidationRun.

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
 
 

◆ execute()

execute ( self )

inherited


Run the basf2 job

Reimplemented from EmptyRun.

Definition at line 130 of file event_generation.py.

    def execute(self):
        """Run the basf2 job"""
        if not self.simulation_output:
            super().execute()
            return
 
        # Run only simulation
        path = ReadOrGenerateEventsRun.create_path(self)
        self.run(path)
 

◆ name()

name ( self )

inherited


provide name of this object

Definition at line 41 of file minimal.py.

41 def name(self):

42 """provide name of this object"""

43 return self.__class__.__name__

44

◆ run()

run	(		self,
			path )

inherited


Process the basf2 path

Reimplemented in PostProcessingRunMixin.

Definition at line 58 of file minimal.py.

    def run(self, path):
        """Process the basf2 path"""
        # Run basf2 module path #
        
        get_logger().info('Start processing')
        basf2.print_path(path)
        basf2.process(path)
        get_logger().info("\n%s", str(basf2.statistics))
 

Member Data Documentation

◆ allow_input

bool allow_input = True

staticinherited

By default, this basf2 job can read events from an input ROOT TFile.

Definition at line 109 of file minimal.py.

◆ bkg_files

list bkg_files = []

staticinherited

By default, no background overlay.

Definition at line 47 of file event_generation.py.

◆ components

components = None

staticinherited

By default, do specific components.

Definition at line 49 of file event_generation.py.

◆ description

str description = "Empty execution of basf2"

staticinherited

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

Definition at line 33 of file minimal.py.

◆ detector_setup

str detector_setup = "Default"

staticinherited

By default, use the default detector setup.

Definition at line 45 of file event_generation.py.

◆ disable_deltas

bool disable_deltas = False

staticinherited

By default, do not disable delta-ray generation.

Definition at line 51 of file event_generation.py.

◆ finder_module

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 CDCAutomaton, CDCAutomaton, CDCCombined, CDCCombined, CDCCR, CDCFull, CDCFull, CDCLegendre, CDCLegendre, CombinedSVDTrackingValidation, CombinedSVDTrackingValidationBkg, CosmicsAxialHough, CosmicsHough, InvertedFullBkg, fullTrackingValidation_plusECL, Full, SVDHoughTrackingValidation, SVDHoughTrackingValidationBkg, toCDCCKFValidationBkg, toCDCfromEclCKF, toCDCfromEclCKF, and StandardReconstructionEventsRun.

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.

◆ generator_module

generator_module = None

staticinherited

By default, do not generate events.

Definition at line 43 of file 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.

◆ n_events

n_events = 10000

staticinherited

By default, process 10000 events.

Definition at line 111 of file minimal.py.

◆ n_events_to_skip

int n_events_to_skip = 0

staticinherited

By default, do not skip any events at the start of the input ROOT TFile.

Definition at line 119 of file minimal.py.

◆ n_processes

n_processes = 0

staticinherited

By default, no parallel processing.

Definition at line 117 of file minimal.py.

◆ random_seed

random_seed = None

staticinherited

By default, the random-number seed is unassigned.

Definition at line 115 of file minimal.py.

◆ root_input_file

root_input_file = None

staticinherited

By default, there is no input ROOT TFile.

Definition at line 113 of file minimal.py.

◆ simulation_output

simulation_output = None

staticinherited

By default, do no store the simulation output.

Definition at line 53 of file 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

◆ adjust_path()

◆ configure()

◆ configure_and_execute_from_commandline()

◆ configure_from_commandline()

◆ create_argument_parser()

◆ create_path()

◆ execute()

◆ name()

◆ run()

Member Data Documentation

◆ allow_input

◆ bkg_files

◆ components

◆ description

◆ detector_setup

◆ disable_deltas

◆ finder_module

◆ fit_tracks

◆ generator_module

◆ mc_tracking

◆ n_events

◆ n_events_to_skip

◆ n_processes

◆ random_seed

◆ root_input_file

◆ simulation_output

◆ tracking_coverage